Function decodeJwtHeader

decodeJwtHeader<HeaderSchema extends BaseSchema | undefined = undefined>(
options: DecodeJwtHeaderOptions<HeaderSchema>,
): DecodeJwtHeaderResult<HeaderSchema>
Decodes and validates the header of a compact JWT.

This helper does not verify the JWT signature or parse the payload.
Type Parameters
- HeaderSchema extends BaseSchema | undefined = undefined
Parameters
- options: DecodeJwtHeaderOptions<HeaderSchema>
  Header decode options.
  - OptionalerrorMessagePrefix?: string
    Optional prefix for error messages thrown during decoding, to provide more context on where the error occurred
  - OptionalheaderSchema?: HeaderSchema
    Schema to use for validating the header. If not provided the default zJwtHeader schema will be used
  - jwt: string
    The compact encoded jwt
Returns DecodeJwtHeaderResult<HeaderSchema>
Decoded and schema-validated JWT header.

Throws
If the JWT shape or header JSON is invalid.

Throws
If header schema validation fails.
- Defined in packages/oauth2/src/common/jwt/decode-jwt-header.ts:54