Class Parser

Default parser implementation of Zibri.

Implements

Index

Constructors

Methods

onAppInit parseBody parseHeaderParam parsePathParam parseQueryParam

Constructors

constructor

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

Methods

onAppInit

onAppInit(): Promise<void>
Runs when the app initializes.

Returns Promise<void>
Implementation of OnAppInit.onAppInit
- Defined in src/parsing/parser.ts:151

parseBody

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

parseHeaderParam

parseHeaderParam(
    req:
        | HttpRequest
        | WebsocketRequest<
            unknown,
            Record<string, string | undefined>,
            Record<string, string | undefined>,
            Partial<Record<Header, string | undefined>>,
        >
        | HttpClientResponse,
    metadata: HeaderParamMetadata,
): unknown
Parses the header param resolved from the given metadata.
Parameters
- req:
      | HttpRequest
      | WebsocketRequest<
          unknown,
          Record<string, string | undefined>,
          Record<string, string | undefined>,
          Partial<Record<Header, string | undefined>>,
      >
      | HttpClientResponse
- metadata: HeaderParamMetadata
Returns unknown
Implementation of ParserInterface.parseHeaderParam
- Defined in src/parsing/parser.ts:95

parsePathParam

parsePathParam(
    req:
        | HttpRequest
        | WebsocketRequest<
            unknown,
            Record<string, string | undefined>,
            Record<string, string | undefined>,
            Partial<Record<Header, string | undefined>>,
        >,
    metadata: PathParamMetadata,
): unknown
Parses the path param resolved from the given metadata.
Parameters
- req:
      | HttpRequest
      | WebsocketRequest<
          unknown,
          Record<string, string | undefined>,
          Record<string, string | undefined>,
          Partial<Record<Header, string | undefined>>,
      >
- metadata: PathParamMetadata
Returns unknown
Implementation of ParserInterface.parsePathParam
- Defined in src/parsing/parser.ts:108

parseQueryParam

parseQueryParam(
    req:
        | HttpRequest
        | WebsocketRequest<
            unknown,
            Record<string, string | undefined>,
            Record<string, string | undefined>,
            Partial<Record<Header, string | undefined>>,
        >,
    metadata: QueryParamMetadata,
): unknown
Parses the query param resolved from the given metadata.
Parameters
- req:
      | HttpRequest
      | WebsocketRequest<
          unknown,
          Record<string, string | undefined>,
          Record<string, string | undefined>,
          Partial<Record<Header, string | undefined>>,
      >
- metadata: QueryParamMetadata
Returns unknown
Implementation of ParserInterface.parseQueryParam
- Defined in src/parsing/parser.ts:101