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

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:56

Methods

delete

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

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:127

get

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

getCookiePrefix

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

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

save

save(
resCookies: ResponseCookies,
transactionState: TransactionState,
): Promise<void>
Parameters
- resCookies: ResponseCookies
- transactionState: TransactionState
Returns Promise<void>
- Defined in src/server/transaction-store.ts:85