Class AstroAdapter

Api Server adapter wrapping the Astro API environment. Maps Quatrain's standardized ServerAdapter interfaces to web standards (Request/Response) used by Astro.

Implements

ServerAdapter

Index

Constructors

constructor

Methods

addEndpoint addMiddleware createRouter delete get getNativeInstance handle patch post put serveStatic start use wrap

Constructors

constructor

new AstroAdapter(
    prefix?: string,
    routesRef?: RegisteredRoute[],
    middlewaresRef?: ApiMiddleware[],
): AstroAdapter
Instantiates a new AstroAdapter.
Parameters
- prefix: string = ''
  Prefix URL segment (e.g. '/api').
- OptionalroutesRef: RegisteredRoute[]
  Internal reference sharing existing routes list.
- OptionalmiddlewaresRef: ApiMiddleware[]
  Internal reference sharing existing middlewares.
Returns AstroAdapter
- Defined in AstroAdapter.ts:158

Methods

addEndpoint

addEndpoint(
    handler: EndpointHandler,
    endpointRoot: string,
    options?: EndpointOptions,
): void
Registers a modular sub-endpoint namespace.
Parameters
- handler: EndpointHandler
  The endpoints builder method.
- endpointRoot: string
  The route mapping context prefix.
- options: EndpointOptions = {}
  Additional router options.
Returns void
Implementation of ServerAdapter.addEndpoint
- Defined in AstroAdapter.ts:336

addMiddleware

addMiddleware(middleware: ApiMiddleware): void
Appends a strict ApiMiddleware to the router execution flow.
Parameters
- middleware: ApiMiddleware
  The middleware callback function.
Returns void
Implementation of ServerAdapter.addMiddleware
- Defined in AstroAdapter.ts:284

createRouter

createRouter(path: string): ServerAdapter
Instantiates and returns a sub-router mapping to a nested prefix.
Parameters
- path: string
  The nested sub-path segment prefix.
Returns ServerAdapter
A new ServerAdapter adapter instance bound to the prefix.
Implementation of ServerAdapter.createRouter
- Defined in AstroAdapter.ts:294

delete

delete(path: string, ...handlers: ApiHandler[]): void
Registers a handler for DELETE requests.
Parameters
- path: string
  The relative routing path.
- ...handlers: ApiHandler[]
  Route handler(s) and optional middlewares.
Returns void
Implementation of ServerAdapter.delete
- Defined in AstroAdapter.ts:225
delete(path: string, ...handlers: any[]): void
Registers a handler for DELETE requests.
Parameters
- path: string
  The relative routing path.
- ...handlers: any[]
  Route handler(s) and optional middlewares.
Returns void
Implementation of ServerAdapter.delete
- Defined in AstroAdapter.ts:226

get

get(path: string, ...handlers: ApiHandler[]): void
Registers a handler for GET requests.
Parameters
- path: string
  The relative routing path.
- ...handlers: ApiHandler[]
  Route handler(s) and optional middlewares.
Returns void
Implementation of ServerAdapter.get
- Defined in AstroAdapter.ts:177
get(path: string, ...handlers: any[]): void
Registers a handler for GET requests.
Parameters
- path: string
  The relative routing path.
- ...handlers: any[]
  Route handler(s) and optional middlewares.
Returns void
Implementation of ServerAdapter.get
- Defined in AstroAdapter.ts:178

getNativeInstance

getNativeInstance(): any
Returns the underlying router or runtime handler container.

Returns any
AstroAdapter instance itself.
Implementation of ServerAdapter.getNativeInstance
- Defined in AstroAdapter.ts:325

handle

handle(): any
Returns an Astro APIRoute handler that resolves dynamic catch-all route matching.

Returns any
The compiled Astro APIRoute handler.
- Defined in AstroAdapter.ts:404

patch

patch(path: string, ...handlers: ApiHandler[]): void
Registers a handler for PATCH requests.
Parameters
- path: string
  The relative routing path.
- ...handlers: ApiHandler[]
  Route handler(s) and optional middlewares.
Returns void
Implementation of ServerAdapter.patch
- Defined in AstroAdapter.ts:213
patch(path: string, ...handlers: any[]): void
Registers a handler for PATCH requests.
Parameters
- path: string
  The relative routing path.
- ...handlers: any[]
  Route handler(s) and optional middlewares.
Returns void
Implementation of ServerAdapter.patch
- Defined in AstroAdapter.ts:214

post

post(path: string, ...handlers: ApiHandler[]): void
Registers a handler for POST requests.
Parameters
- path: string
  The relative routing path.
- ...handlers: ApiHandler[]
  Route handler(s) and optional middlewares.
Returns void
Implementation of ServerAdapter.post
- Defined in AstroAdapter.ts:189
post(path: string, ...handlers: any[]): void
Registers a handler for POST requests.
Parameters
- path: string
  The relative routing path.
- ...handlers: any[]
  Route handler(s) and optional middlewares.
Returns void
Implementation of ServerAdapter.post
- Defined in AstroAdapter.ts:190

put

put(path: string, ...handlers: ApiHandler[]): void
Registers a handler for PUT requests.
Parameters
- path: string
  The relative routing path.
- ...handlers: ApiHandler[]
  Route handler(s) and optional middlewares.
Returns void
Implementation of ServerAdapter.put
- Defined in AstroAdapter.ts:201
put(path: string, ...handlers: any[]): void
Registers a handler for PUT requests.
Parameters
- path: string
  The relative routing path.
- ...handlers: any[]
  Route handler(s) and optional middlewares.
Returns void
Implementation of ServerAdapter.put
- Defined in AstroAdapter.ts:202

serveStatic

serveStatic(folderPath: string, apiPrefix?: string): void
Stub serving static files (handled natively by Astro).
Parameters
- folderPath: string
  Public filesystem directory.
- OptionalapiPrefix: string
  Endpoint segment prefix.
Returns void
Implementation of ServerAdapter.serveStatic
- Defined in AstroAdapter.ts:316

start

start(port: number, callback?: () => void): void
Stub starting the server environment (handled natively by Astro).
Parameters
- port: number
  Target port.
- Optionalcallback: () => void
  Optional completion routine.
Returns void
Implementation of ServerAdapter.start
- Defined in AstroAdapter.ts:305

use

use(middleware: any): void
Appends middleware routines to the router execution flow.
Parameters
- middleware: any
  The middleware callback function.
Returns void
Implementation of ServerAdapter.use
- Defined in AstroAdapter.ts:273

`Static`wrap

wrap(handler: ApiHandler): any
Static helper to wrap a single Quatrain ApiHandler into a native Astro APIRoute.
Parameters
- handler: ApiHandler
  The Quatrain API action handler.
Returns any
The wrapped Astro APIRoute execution callback.
- Defined in AstroAdapter.ts:350

Class AstroAdapter

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AstroAdapter

Methods

addEndpoint

Parameters

Returns void

addMiddleware

Parameters

Returns void

createRouter

Parameters

Returns ServerAdapter

delete

Parameters

Returns void

Parameters

Returns void

get

Parameters

Returns void

Parameters

Returns void

getNativeInstance

Returns any

handle

Returns any

patch

Parameters

Returns void

Parameters

Returns void

post

Parameters

Returns void

Parameters

Returns void

put

Parameters

Returns void

Parameters

Returns void

serveStatic

Parameters

Returns void

start

Parameters

Returns void

use

Parameters

Returns void

Staticwrap

Parameters

Returns any

Settings

On This Page

`Static`wrap