diff --git a/src/index.ts b/src/index.ts index 146664f..603a779 100644 --- a/src/index.ts +++ b/src/index.ts @@ -21,7 +21,7 @@ export interface JwtAlgorithms { export interface JwtHeader { /** * Type (default: `"JWT"`) - * + * * @default "JWT" */ typ?: string @@ -89,7 +89,7 @@ export interface JwtSignOptions extends JwtOptions { export interface JwtVerifyOptions extends JwtOptions { /** * If `true` throw error if checks fail. (default: `false`) - * + * * @default false */ throwError?: boolean @@ -169,7 +169,7 @@ function _decodePayload(raw: string): JwtHeader | JwtPayload | null { /** * Signs a payload and returns the token - * + * * @param {JwtPayload} payload The payload object. To use `nbf` (Not Before) and/or `exp` (Expiration Time) add `nbf` and/or `exp` to the payload. * @param {string} secret A string which is used to sign the payload. * @param {JwtSignOptions | JwtAlgorithm | string} [options={ algorithm: 'HS256', header: { typ: 'JWT' } }] The options object or the algorithm. @@ -215,12 +215,12 @@ export async function sign(payload: JwtPayload, secret: string, options: JwtSign /** * Verifies the integrity of the token and returns a boolean value. - * + * * @param {string} token The token string generated by `jwt.sign()`. * @param {string} secret The string which was used to sign the payload. * @param {JWTVerifyOptions | JWTAlgorithm} options The options object or the algorithm. * @throws {Error | string} Throws an error `string` if the token is invalid or an `Error-Object` if there's a validation issue. - * @returns {Promise} Returns `true` if signature, `nbf` (if set) and `exp` (if set) are valid, otherwise returns `false`. + * @returns {Promise} Returns `true` if signature, `nbf` (if set) and `exp` (if set) are valid, otherwise returns `false`. */ export async function verify(token: string, secret: string, options: JwtVerifyOptions | JwtAlgorithm = { algorithm: 'HS256', throwError: false }): Promise { if (typeof options === 'string') @@ -282,7 +282,7 @@ export async function verify(token: string, secret: string, options: JwtVerifyOp /** * Returns the payload **without** verifying the integrity of the token. Please use `jwt.verify()` first to keep your application secure! - * + * * @param {string} token The token string generated by `jwt.sign()`. * @returns {JwtData} Returns an `object` containing `header` and `payload`. */