Function parseQueryParams

Parses and validates query parameters using a provided schema.

Throws

  • If the validation fails or if the schema is provided without query parameters.
  • parseQueryParams<TQueryParams>(queryParams?, queryParamsSchema?): undefined | TQueryParams

  • Type Parameters

    • TQueryParams = Record<string,
          | string
          | number
          | boolean
          | (string | number | boolean)[]>

      The type of the query parameters.

    Parameters

    • OptionalqueryParams: TQueryParams

      The query parameters to be validated.

    • OptionalqueryParamsSchema: ZodType<any, ZodTypeDef, any>

      The Zod schema to validate the query parameters.

    Returns undefined | TQueryParams

    • The validated query parameters or undefined if not provided.

Settings

Member Visibility