Class RatchetStorage`Abstract`

Hierarchy

RatchetStorage
- MemoryStorage
- FileStorage

Index

Constructors

Methods

create createIdentity findSession getIdentity isTrusted loadIdentities loadRemoteIdentity loadSession removeRemoteIdentity saveIdentities saveRemoteIdentity saveSession create

Constructors

constructor

new RatchetStorage(): RatchetStorage
Returns RatchetStorage

Methods

`Protected` `Abstract` create

create(): Promise<void>
Returns Promise<void>
- Defined in packages/server/src/connection/storages/base.ts:65

createIdentity

createIdentity(preKeyAmount?: number): Promise<Identity>
Parameters
- preKeyAmount: number = 10
Returns Promise<Identity>
- Defined in packages/server/src/connection/storages/base.ts:24

`Abstract` findSession

findSession(key: CryptoKey): Promise<null | AsymmetricRatchet>
Parameters
- key: CryptoKey
Returns Promise<null | AsymmetricRatchet>
- Defined in packages/server/src/connection/storages/base.ts:63

`Abstract` getIdentity

getIdentity(origin: string): Promise<Identity>
Returns identity by domain origin. If identity doesn't exist creates new
Parameters
- origin: string
  
  Domain origin
Returns Promise<Identity>
- Defined in packages/server/src/connection/storages/base.ts:22

isTrusted

isTrusted(remoteIdentity: RemoteIdentity): Promise<boolean>
Parameters
- remoteIdentity: RemoteIdentity
Returns Promise<boolean>
- Defined in packages/server/src/connection/storages/base.ts:49

`Abstract` loadIdentities

loadIdentities(): Promise<void>
Returns Promise<void>
- Defined in packages/server/src/connection/storages/base.ts:15

`Abstract` loadRemoteIdentity

loadRemoteIdentity(key: string): Promise<null | RemoteIdentity>
Returns remote identity by key
Parameters
- key: string
  
  identifier of identity
Returns Promise<null | RemoteIdentity>
- Defined in packages/server/src/connection/storages/base.ts:34

`Abstract` loadSession

loadSession(key: string): Promise<AsymmetricRatchet>
Parameters
- key: string
Returns Promise<AsymmetricRatchet>
- Defined in packages/server/src/connection/storages/base.ts:61

`Abstract` removeRemoteIdentity

removeRemoteIdentity(key: string): Promise<void>
Remove remote identity from storage by key
Parameters
- key: string
  
  identifier of identity
Returns Promise<void>
- Defined in packages/server/src/connection/storages/base.ts:47

`Abstract` saveIdentities

saveIdentities(): Promise<void>
Returns Promise<void>
- Defined in packages/server/src/connection/storages/base.ts:16

`Abstract` saveRemoteIdentity

saveRemoteIdentity(key: string, value: RemoteIdentity): Promise<void>
Adds remote identity to storage
Parameters
- key: string
  
  identifier of identity
- value: RemoteIdentity
  
  remote identity
Returns Promise<void>
- Defined in packages/server/src/connection/storages/base.ts:41

`Abstract` saveSession

saveSession(key: string, value: AsymmetricRatchet): Promise<void>
Parameters
- key: string
- value: AsymmetricRatchet
Returns Promise<void>
- Defined in packages/server/src/connection/storages/base.ts:62

`Static` create

create<T>(this: (new () => T)): Promise<RatchetStorage>
Type Parameters
- T extends RatchetStorage<T>
Parameters
- this: (new () => T)
  - - new (): T
    - Returns T
Returns Promise<RatchetStorage>
- Defined in packages/server/src/connection/storages/base.ts:9

Generated using TypeDoc