Keyring
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:121
Constructors
Constructor
new Keyring(opts): Keyring;
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:144
Parameters
| Parameter | Type |
|---|---|
opts | CreateKeyringOptions |
Returns
Keyring
Properties
namespace
readonly namespace: string;
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:130
Accessors
isLocked
Get Signature
get isLocked(): boolean;
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:132
Returns
boolean
kid
Get Signature
get kid(): string | null;
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:136
Returns
string | null
lockChange$
Get Signature
get lockChange$(): Observable<boolean>;
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:140
Returns
Observable<boolean>
Methods
decrypt()
decrypt(args): Promise<Uint8Array<ArrayBufferLike>>;
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:187
Parameters
| Parameter | Type |
|---|---|
args | DecryptArgs |
Returns
Promise<Uint8Array<ArrayBufferLike>>
encrypt()
encrypt(args): Promise<string>;
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:168
Parameters
| Parameter | Type |
|---|---|
args | EncryptArgs |
Returns
Promise<string>
isInitialized()
isInitialized(): Promise<boolean>;
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:149
Returns
Promise<boolean>
lock()
lock(): void;
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:160
Returns
void
touch()
touch(): void;
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:231
Re-arm the idle auto-lock timer. Called internally on every successful encrypt/decrypt. Public for tests / advanced callers that want to extend the idle window without performing a crypto op.
Returns
void
unlock()
unlock(opts): Promise<void>;
Defined in: packages/rxdb-adapter-encrypted/src/keyring.ts:154
Parameters
| Parameter | Type |
|---|---|
opts | UnlockOptions |
Returns
Promise<void>