Class InboundSyns<INTERNALIN, INTERNALRETURN, INTERNALRES, INTERNALOUT>`Abstract`

Represents an inbound synchronization route with specific types for input, return, response, and output.

Type Parameters

INTERNALIN
The type of the input request.
INTERNALRETURN
The type of the data returned from the extract function.
INTERNALRES
The type of the data returned from the process function.
INTERNALOUT
The type of the output response.

Implements

HttpBase

Index

Constructors

Properties

DESCRIPTION? ID METHOD ROUTE_URL TYPE

Methods

extract initialize process? respond

Constructors

constructor

new InboundSyns<INTERNALIN, INTERNALRETURN, INTERNALRES, INTERNALOUT>(): InboundSyns<
    INTERNALIN,
    INTERNALRETURN,
    INTERNALRES,
    INTERNALOUT,
>
Type Parameters
- INTERNALIN
- INTERNALRETURN
- INTERNALRES
- INTERNALOUT
Returns InboundSyns<INTERNALIN, INTERNALRETURN, INTERNALRES, INTERNALOUT>

Properties

`Optional`DESCRIPTION

DESCRIPTION?: string

A description of the route.

`Abstract`ID

ID: string

The unique identifier for the route.

`Abstract`METHOD

METHOD: HttpMethod

The HTTP method used by the route (e.g., GET, POST).

`Abstract`ROUTE_URL

ROUTE_URL: string

The URL path of the route.

`Abstract`TYPE

TYPE: ROUTETYPE

The type of the route, defined by the ROUTETYPE enum.

Methods

`Abstract`extract

extract(request: INTERNALIN): Promise<INTERNALRETURN>
A function that extracts data from the input request.
Parameters
- request: INTERNALIN
Returns Promise<INTERNALRETURN>
- Defined in routes/http/inboundSync.ts:50

initialize

initialize(
    app: FastifyInstance<
        RawServerDefault,
        IncomingMessage,
        ServerResponse<IncomingMessage>,
        FastifyBaseLogger,
        FastifyTypeProviderDefault,
    >,
): Promise<void>
Parameters
- app: FastifyInstance<
      RawServerDefault,
      IncomingMessage,
      ServerResponse<IncomingMessage>,
      FastifyBaseLogger,
      FastifyTypeProviderDefault,
  >
Returns Promise<void>
Implementation of HttpBase.initialize
- Defined in routes/http/inboundSync.ts:26

`Optional`process

process(data: INTERNALRETURN): Promise<INTERNALRES>
An optional function that processes the extracted data.
Parameters
- data: INTERNALRETURN
Returns Promise<INTERNALRES>
- Defined in routes/http/inboundSync.ts:51

`Abstract`respond

respond(response: INTERNALRES): Promise<INTERNALOUT>
A function that generates the output response from the processed data.
Parameters
- response: INTERNALRES
Returns Promise<INTERNALOUT>
- Defined in routes/http/inboundSync.ts:52