Class TransactionStore

TransactionStore is responsible for storing the state required to successfully complete an authentication transaction. The store relies on encrypted, stateless cookies to store the transaction state.

Index

Constructors

constructor

Methods

delete deleteAll get getCookiePrefix save

Constructors

constructor

new TransactionStore(
__namedParameters: TransactionStoreOptions,
): TransactionStore
Parameters
- __namedParameters: TransactionStoreOptions
Returns TransactionStore
- Defined in src/server/transaction-store.ts:194

Methods

delete

delete(resCookies: ResponseCookies, state: string): Promise<void>
Parameters
- resCookies: ResponseCookies
- state: string
Returns Promise<void>
- Defined in src/server/transaction-store.ts:430

deleteAll

deleteAll(
reqCookies: RequestCookies,
resCookies: ResponseCookies,
): Promise<void>
Deletes all transaction cookies based on the configured prefix.
Parameters
- reqCookies: RequestCookies
- resCookies: ResponseCookies
Returns Promise<void>
- Defined in src/server/transaction-store.ts:443

get

get(
reqCookies: RequestCookies,
state: string,
): Promise<JWTDecryptResult<TransactionState> | null>
Parameters
- reqCookies: RequestCookies
- state: string
Returns Promise<JWTDecryptResult<TransactionState> | null>
- Defined in src/server/transaction-store.ts:415

getCookiePrefix

getCookiePrefix(): string
Returns the configured prefix for transaction cookies.

Returns string
- Defined in src/server/transaction-store.ts:227

save

save(
    resCookies: ResponseCookies,
    transactionState: TransactionState,
    reqCookies?: RequestCookies | ReadonlyRequestCookies,
): Promise<void>
Saves the transaction state to an encrypted cookie.
Parameters
- resCookies: ResponseCookies
  The response cookies object to set the transaction cookie on
- transactionState: TransactionState
  The transaction state to save
- OptionalreqCookies: RequestCookies | ReadonlyRequestCookies
  Optional request cookies. When provided, enables FIFO eviction of accumulated transaction cookies (capped at MAX_TRANSACTION_COOKIE_BYTES) before writing the new cookie.
Returns Promise<void>

Throws
When transaction state is missing required state parameter
- Defined in src/server/transaction-store.ts:242

Class TransactionStore

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns TransactionStore

Methods

delete

Parameters

Returns Promise<void>

deleteAll

Parameters

Returns Promise<void>

get

Parameters

Returns Promise<JWTDecryptResult<TransactionState> | null>

getCookiePrefix

Returns string

save

Parameters

Returns Promise<void>

Throws

Settings

On This Page