zero-auth

Appearance

zero-auth API Documentation v1.2.0

zero-auth API Documentation / ResolvedConfig

Interface: ResolvedConfig ​

Defined in: src/types/auth.ts:103

Fully resolved config after defaults are applied. Used internally.

Properties ​

accessExpiresIn ​

accessExpiresIn: string

Defined in: src/types/auth.ts:106

accessSecret ​

accessSecret: string

Defined in: src/types/auth.ts:104

cookies ​

cookies: Required<CookieConfig> & object

Defined in: src/types/auth.ts:108

Type Declaration ​

options ​

options: CookieOptions

csrf ​

csrf: object

Defined in: src/types/auth.ts:109

cookieName ​

cookieName: string

headerName ​

headerName: string

methods ​

methods: string[]

refreshExpiresIn ​

refreshExpiresIn: string

Defined in: src/types/auth.ts:107

refreshOptions ​

refreshOptions: object

Defined in: src/types/auth.ts:114

consumeRefreshToken? ​

optional consumeRefreshToken?: (oldJti, ctx?) => boolean | Promise<boolean>

Parameters ​
oldJti ​

string

ctx? ​

RefreshTokenContext

Returns ​

boolean | Promise<boolean>

isRevoked? ​

optional isRevoked?: (jti) => boolean | Promise<boolean>

Parameters ​
jti ​

string

Returns ​

boolean | Promise<boolean>

onRefreshReuse? ​

optional onRefreshReuse?: (ctx) => void | Promise<void>

Parameters ​
ctx ​

RefreshReuseContext

Returns ​

void | Promise<void>

registerRefreshToken? ​

optional registerRefreshToken?: (newJti, ctx) => void | Promise<void>

Parameters ​
newJti ​

string

ctx ​

RefreshTokenContext

Returns ​

void | Promise<void>

revokeRefreshToken? ​

optional revokeRefreshToken?: (oldJti, ctx?) => void | Promise<void>

Parameters ​
oldJti ​

string

ctx? ​

RefreshTokenContext

Returns ​

void | Promise<void>

rotate ​

rotate: boolean

refreshSecret ​

refreshSecret: string

Defined in: src/types/auth.ts:105