Documents for @litert/jwt / Types / IJwaSigner

Interface: IJwaSigner

Defined in: src/lib/Types.ts:349

The type of the signer objects used in stringify API, to sign the JWTs.

Properties

digestType

readonly digestType: EDigestType

Defined in: src/lib/Types.ts:368

The digest type to use for signing.

---

family

readonly family: ESigningAlgoFamily

Defined in: src/lib/Types.ts:353

The signing algorithm family.

---

jwa

readonly jwa: ESigningJwa

Defined in: src/lib/Types.ts:363

The signing algorithm to use, for the alg claim in the JWT header.

---

keyId?

readonly optional keyId: string | null

Defined in: src/lib/Types.ts:358

The key ID to use in the JWT header.

Methods

sign()

sign(data): Buffer

Defined in: src/lib/Types.ts:377

Sign the provided data and return the signature.

Parameters

data

The data to sign.

string | Buffer<ArrayBufferLike>

Returns

Buffer

The signature.