Interface DecodeJwtHeaderOptions<HeaderSchema>

interface DecodeJwtHeaderOptions<HeaderSchema extends BaseSchema | undefined> {
    errorMessagePrefix?: string;
    headerSchema?: HeaderSchema;
    jwt: string;
}

Type Parameters

HeaderSchema extends BaseSchema | undefined

Index

Properties

errorMessagePrefix? headerSchema? jwt

Properties

`Optional`errorMessagePrefix

errorMessagePrefix?: string

Optional prefix for error messages thrown during decoding, to provide more context on where the error occurred

`Optional`headerSchema

headerSchema?: HeaderSchema

Schema to use for validating the header. If not provided the default zJwtHeader schema will be used

jwt

jwt: string

The compact encoded jwt