Interface ParserInterface

Interface for a parser.

interface ParserInterface {
    attachTo: (app: ZibriApplication) => void | Promise<void>;
    parseBody: (
        req: HttpRequest | WebsocketRequest | HttpClientResponse,
        metadata: BodyMetadata,
    ) => unknown;
    parseHeaderParam: (
        req: HttpRequest | WebsocketRequest | HttpClientResponse,
        metadata: HeaderParamMetadata,
    ) => unknown;
    parsePathParam: (
        req: HttpRequest | WebsocketRequest,
        metadata: PathParamMetadata,
    ) => unknown;
    parseQueryParam: (
        req: HttpRequest | WebsocketRequest,
        metadata: QueryParamMetadata,
    ) => unknown;
}

Implemented by

Parser

Index

Properties

attachTo parseBody parseHeaderParam parsePathParam parseQueryParam

Properties

attachTo

attachTo: (app: ZibriApplication) => void | Promise<void>

Attaches the parser to the Zibri application.

parseBody

parseBody: (
req: HttpRequest | WebsocketRequest | HttpClientResponse,
metadata: BodyMetadata,
) => unknown

Parses the body resolved from the given metadata.

parseHeaderParam

parseHeaderParam: (
req: HttpRequest | WebsocketRequest | HttpClientResponse,
metadata: HeaderParamMetadata,
) => unknown

Parses the header param resolved from the given metadata.

parsePathParam

parsePathParam: (
req: HttpRequest | WebsocketRequest,
metadata: PathParamMetadata,
) => unknown

Parses the path param resolved from the given metadata.

parseQueryParam

parseQueryParam: (
req: HttpRequest | WebsocketRequest,
metadata: QueryParamMetadata,
) => unknown

Parses the query param resolved from the given metadata.