Interface ParserInterface

Interface for a parser.

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

Properties

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

Attaches the parser to the Zibri application.

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

Parses the header param resolved from the given metadata.

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

Parses the path param resolved from the given metadata.

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

Parses the query param resolved from the given metadata.

parseRequestBody: (req: HttpRequest, metadata: BodyMetadata) => Promise<unknown>

Parses the request body resolved from the given metadata.