supertokens-node/recipe/jwt/types

References documentation for the supertokens-node/recipe/jwt/types package

Type Aliases

type APIInterface = object;

Property	Type	Defined in
`getJWKSGET`	\| `undefined` \| (`input`) => `Promise`< \| { `keys`: `JsonWebKey`[]; } \| `GeneralErrorResponse`>	recipe/jwt/types.ts

type APIOptions = object;

type JsonWebKey = object;

type RecipeInterface = object;

createJWT(input): Promise<
  | {
  jwt: string;
  status: "OK";
}
  | {
  status: "UNSUPPORTED_ALGORITHM_ERROR";
}>;

Parameter	Type
`input`	{ `payload?`: `any`; `userContext`: `UserContext`; `useStaticSigningKey?`: `boolean`; `validitySeconds?`: `number`; }
`input.payload?`	`any`
`input.userContext`	`UserContext`
`input.useStaticSigningKey?`	`boolean`
`input.validitySeconds?`	`number`

Promise< | { jwt: string; status: "OK"; } | { status: "UNSUPPORTED_ALGORITHM_ERROR"; }>

getJWKS(input): Promise<{
  keys: JsonWebKey[];
  validityInSeconds?: number;
}>;

Parameter	Type
`input`	{ `userContext`: `UserContext`; }
`input.userContext`	`UserContext`

Promise<{ keys: JsonWebKey[]; validityInSeconds?: number; }>

type TypeInput = object;

Property	Type	Defined in
`jwtValiditySeconds?`	`number`	recipe/jwt/types.ts
`override?`	`object`	recipe/jwt/types.ts
`override.apis?`	(`originalImplementation`, `builder`) => `APIInterface`	recipe/jwt/types.ts
`override.functions?`	(`originalImplementation`, `builder`) => `RecipeInterface`	recipe/jwt/types.ts

type TypeNormalisedInput = object;

Property	Type	Defined in
`jwtValiditySeconds`	`number`	recipe/jwt/types.ts
`override`	`object`	recipe/jwt/types.ts
`override.apis`	(`originalImplementation`, `builder`) => `APIInterface`	recipe/jwt/types.ts
`override.functions`	(`originalImplementation`, `builder`) => `RecipeInterface`	recipe/jwt/types.ts