Class ExpiringAdapter

An IDP storage adapter that uses an ExpiringStorage to persist data.

Hierarchy

ExpiringAdapter

Implements

Adapter

Index

Constructors

Properties

logger name storage

Methods

consume destroy find findByUid findByUserCode grantKeyFor keyFor revokeByGrantId uidKeyFor upsert userCodeKeyFor

Constructors

constructor

new ExpiringAdapter(name, storage): ExpiringAdapter
Parameters
- name: string
- storage: ExpiringStorage<string, unknown>
Returns ExpiringAdapter
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:16

Properties

`Protected` `Readonly` logger

logger: Logger = ...

`Private` `Readonly` name

name: string

`Private` `Readonly` storage

storage: ExpiringStorage<string, unknown>

Methods

consume

consume(id): Promise<void>
Parameters
- id: string
Returns Promise<void>
Implementation of Adapter.consume
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:99

destroy

destroy(id): Promise<void>
Parameters
- id: string
Returns Promise<void>
Implementation of Adapter.destroy
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:80

find

find(id): Promise<void | AdapterPayload>
Parameters
- id: string
Returns Promise<void | AdapterPayload>
Implementation of Adapter.find
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:66

findByUid

findByUid(uid): Promise<void | AdapterPayload>
Parameters
- uid: string
Returns Promise<void | AdapterPayload>
Implementation of Adapter.findByUid
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:75

findByUserCode

findByUserCode(userCode): Promise<void | AdapterPayload>
Parameters
- userCode: string
Returns Promise<void | AdapterPayload>
Implementation of Adapter.findByUserCode
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:70

`Private` grantKeyFor

grantKeyFor(id): string
Parameters
- id: string
Returns string
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:21

`Private` keyFor

keyFor(id): string
Parameters
- id: string
Returns string
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:33

revokeByGrantId

revokeByGrantId(grantId): Promise<void>
Parameters
- grantId: string
Returns Promise<void>
Implementation of Adapter.revokeByGrantId
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:84

`Private` uidKeyFor

uidKeyFor(uid): string
Parameters
- uid: string
Returns string
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:29

upsert

upsert(id, payload, expiresIn?): Promise<void>
Parameters
- id: string
- payload: AdapterPayload
- Optional expiresIn: number
Returns Promise<void>
Implementation of Adapter.upsert
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:37

`Private` userCodeKeyFor

userCodeKeyFor(userCode): string
Parameters
- userCode: string
Returns string
- Defined in src/identity/storage/ExpiringAdapterFactory.ts:25