Class Parser

Default parser implementation of Zibri.

Implements

ParserInterface

Index

Constructors

Methods

attachTo parseBody parseHeaderParam parsePathParam parseQueryParam

Constructors

constructor

new Parser(): Parser
Returns Parser
- Defined in src/parsing/parser.ts:60

Methods

attachTo

attachTo(app: ZibriApplication): Promise<void>
Attaches the parser to the Zibri application.
Parameters
- app: ZibriApplication
Returns Promise<void>
Implementation of ParserInterface.attachTo
- Defined in src/parsing/parser.ts:119

parseBody

parseBody(
req: HttpRequest | WebsocketRequest | HttpClientResponse,
metadata: BodyMetadata,
): Promise<unknown>
Parses the body resolved from the given metadata.
Parameters
- req: HttpRequest | WebsocketRequest | HttpClientResponse
- metadata: BodyMetadata
Returns Promise<unknown>
Implementation of ParserInterface.parseBody
- Defined in src/parsing/parser.ts:83

parseHeaderParam

parseHeaderParam(
req: HttpRequest | WebsocketRequest | HttpClientResponse,
metadata: HeaderParamMetadata,
): unknown
Parses the header param resolved from the given metadata.
Parameters
- req: HttpRequest | WebsocketRequest | HttpClientResponse
- metadata: HeaderParamMetadata
Returns unknown
Implementation of ParserInterface.parseHeaderParam
- Defined in src/parsing/parser.ts:65

parsePathParam

parsePathParam(
req: HttpRequest | WebsocketRequest,
metadata: PathParamMetadata,
): unknown
Parses the path param resolved from the given metadata.
Parameters
- req: HttpRequest | WebsocketRequest
- metadata: PathParamMetadata
Returns unknown
Implementation of ParserInterface.parsePathParam
- Defined in src/parsing/parser.ts:77

parseQueryParam

parseQueryParam(
req: HttpRequest | WebsocketRequest,
metadata: QueryParamMetadata,
): unknown
Parses the query param resolved from the given metadata.
Parameters
- req: HttpRequest | WebsocketRequest
- metadata: QueryParamMetadata
Returns unknown
Implementation of ParserInterface.parseQueryParam
- Defined in src/parsing/parser.ts:71