mirrors/hono
mirrors/hono
0
0
Fork 0
mirror of https://github.com/honojs/hono.git synced 2024-11-21 18:18:57 +01:00
Code Issues Releases Activity

fix(middleware/jwt): Changed the jwt-secret type to SignatureKey (#3167)

Browse Source 
* Changed the jwt-secret type to SignatureKey

* Changed import to type-import
This commit is contained in:
JulesVerner 2024-07-20 11:39:05 +02:00 committed by GitHub
parent 84424ad3a5
commit 09f1d20aff
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
src/middleware/jwt/jwt.ts
View File

@ -11,6 +11,7 @@ import type { CookiePrefixOptions } from '../../utils/cookie'
import { Jwt } from '../../utils/jwt'
import '../../context'
import type { SignatureAlgorithm } from '../../utils/jwt/jwa'
import type { SignatureKey } from '../../utils/jwt/jws'
export type JwtVariables = {
// eslint-disable-next-line @typescript-eslint/no-explicit-any
@ -23,7 +24,7 @@ export type JwtVariables = {
* @see {@link https://hono.dev/docs/middleware/builtin/jwt}
*
* @param {object} options - The options for the JWT middleware.
* @param {string} [options.secret] - A value of your secret key.
* @param {SignatureKey} [options.secret] - A value of your secret key.
* @param {string} [options.cookie] - If this value is set, then the value is retrieved from the cookie header using that value as a key, which is then validated as a token.
* @param {SignatureAlgorithm} [options.alg=HS256] - An algorithm type that is used for verifying. Available types are `HS256` | `HS384` | `HS512` | `RS256` | `RS384` | `RS512` | `PS256` | `PS384` | `PS512` | `ES256` | `ES384` | `ES512` | `EdDSA`.
* @returns {MiddlewareHandler} The middleware handler function.
@ -45,7 +46,7 @@ export type JwtVariables = {
* ```
*/
export const jwt = (options: {
secret: string
secret: SignatureKey
cookie?:
| string
| { key: string; secret?: string | BufferSource; prefixOptions?: CookiePrefixOptions }