Class NonLocalStorage

Provides a persistent, optionally encrypted, remote key-value store. Supports atomic operations, TTL, and presence via websockets.

Remarks

Use this class to interact with the Vaultrice API for storing and retrieving data.

Hierarchy

default
- NonLocalStorage

Constructors

constructor

new NonLocalStorage(credentials: Credentials, id?: string): NonLocalStorage
Create a NonLocalStorage instance.
Parameters
- credentials: Credentials
  API credentials.
- Optionalid: string
  Optional ID.
Returns NonLocalStorage
Overrides WebSocketFunctions.constructor
- Defined in NonLocalStorage.ts:27
new NonLocalStorage(
credentials: Credentials,
options?: InstanceOptions,
): NonLocalStorage
Create a NonLocalStorage instance.
Parameters
- credentials: Credentials
  API credentials.
- Optionaloptions: InstanceOptions
  Optional instance options.
Returns NonLocalStorage
Overrides WebSocketFunctions.constructor
- Defined in NonLocalStorage.ts:36

Properties

id

id: string

Unique instance identifier

`Protected` `Readonly`ttl

ttl: undefined | number

isConnected

isConnected: boolean = false

Indicates if the WebSocket connection is currently established. True if connected, false otherwise. Only relevant/appropriate if having some listeners attached (i.e. nls.on('message')) If not using any WebSocket feature, it will always return false.

`Optional`connectionId

connectionId?: string

Connection ID assigned by the server for the WebSocket connection.

Methods

`Static`retrieveAccessToken

retrieveAccessToken(
    projectId: string,
    apiKey: string,
    apiSecret: string,
    options?: { origin?: string },
): Promise<string>
Retrieves an access token for a given project using API credentials.
Parameters
- projectId: string
  The unique identifier of the project.
- apiKey: string
  The API key associated with the project.
- apiSecret: string
  The API secret associated with the project.
- Optionaloptions: { origin?: string }
  Optional settings for token retrieval.
  - Optionalorigin?: string
    (Optional) The browser origin to use if the API key has configured an origin restriction. Pass this when minting a token from a backend for use in a browser. Example: { origin: req.headers.origin }
Returns Promise<string>
A promise that resolves to the access token as a string.
Example
```
const token = await NonLocalStorage.retrieveAccessToken('projectId', 'apiKey', 'apiSecret');
// When there is an origin restriction:
const token = await NonLocalStorage.retrieveAccessToken('projectId', 'apiKey', 'apiSecret', { origin: req.headers.origin });
```
Inherited from WebSocketFunctions.retrieveAccessToken
- Defined in Base.ts:400

useAccessToken

useAccessToken(accessToken: string): number
Sets the access token to be used for authentication.
Parameters
- accessToken: string
  The access token string to set.
Returns number
token expiration in milliseconds from now

Remarks
When using the token provider authentication method, you typically don't need to call this directly - the SDK handles it automatically.
Inherited from WebSocketFunctions.useAccessToken
- Defined in Base.ts:515

onAccessTokenExpiring

onAccessTokenExpiring(handler: () => void): void
Registers a handler function to be called when the access token is about to expire.
Parameters
- handler: () => void
  A callback function that will be invoked before the access token expires.
Returns void
Inherited from WebSocketFunctions.onAccessTokenExpiring
- Defined in Base.ts:539

offAccessTokenExpiring

offAccessTokenExpiring(handler: () => void): void
Removes a previously registered handler for the access token expiring event.
Parameters
- handler: () => void
  The callback function to remove from the access token expiring handlers list.
Returns void
Inherited from WebSocketFunctions.offAccessTokenExpiring
- Defined in Base.ts:548

getEncryptionSettings

getEncryptionSettings(saltLength?: number): Promise<EncryptionSettingsInfos>
Retrieve or initialize encryption settings for end-to-end encryption.
Parameters
- OptionalsaltLength: number
  Optional salt length in bytes (default: 16).
Returns Promise<EncryptionSettingsInfos>
Promise resolving to encryption settings information.

Throws
Error if called without encryption configuration.

Remarks
This method is mandatory when using end-to-end encryption. It fetches the encryption salt and key version from the server, then initializes the encryption handler.
Inherited from WebSocketFunctions.getEncryptionSettings
- Defined in Base.ts:632

rotateEncryption

rotateEncryption(saltLength?: number): Promise<EncryptionSettingsInfos>
Rotate encryption keys to enhance security.
Parameters
- OptionalsaltLength: number
  Optional salt length in bytes (default: 16).
Returns Promise<EncryptionSettingsInfos>
Promise resolving to new encryption settings information.

Throws
Error if called without encryption configuration.

Remarks
This generates new encryption settings while preserving access to data encrypted with previous keys. Useful for periodic security rotation.
Inherited from WebSocketFunctions.rotateEncryption
- Defined in Base.ts:652

setItem

setItem(
    name: string,
    value: ValueType,
    options?: { ttl?: number; ifAbsent?: boolean; updatedAt?: number },
): Promise<undefined | ItemType>
Store a value by key.
Parameters
- name: string
  The key name.
- value: ValueType
  The value to store.
- Optionaloptions: { ttl?: number; ifAbsent?: boolean; updatedAt?: number }
  Optional overrides.
  - Optionalttl?: number
    Time-to-live in milliseconds for this item.
  - OptionalifAbsent?: boolean
    If true only set if item absent.
  - OptionalupdatedAt?: number
    If provided, the operation will only succeed if the remote item's updatedAt timestamp matches this value.
Returns Promise<undefined | ItemType>
Metadata about the stored item.
Default
```
3600000 (1 hour)
```
Default
```
false
```
Default
```
undefined
```
- Defined in NonLocalStorage.ts:70

setItems

setItems(
    items: Record<
        string,
        { value: ValueType; ttl?: number; ifAbsent?: boolean; updatedAt?: number },
    >,
): Promise<undefined | ItemsType>
Store multiple values at once.
Parameters
- items: Record<
  string,
  { value: ValueType; ttl?: number; ifAbsent?: boolean; updatedAt?: number },
  >
  Object of key/value pairs. Example: { key1: { value: 'foo' }, key2: { value: 'bar', ttl: 3600000 }, key2: { value: 'zip', ifAbsent: true } } ttl is time-to-live in milliseconds for each item.
Returns Promise<undefined | ItemsType>
Metadata for each stored item.
Default
3600000 (1 hour) ifAbsent if true only set if item absent - for each item.

Default
false updatedAt If provided, the operation will only succeed if the remote item's updatedAt timestamp matches this value.
Default
```
undefined
```
- Defined in NonLocalStorage.ts:113

getItem

getItem<T = ValueType>(name: string): Promise<undefined | ItemType<T>>
Retrieve a value by key.
Type Parameters
- T = ValueType
Parameters
- name: string
  The key name.
Returns Promise<undefined | ItemType<T>>
The item, or undefined if not found.
- Defined in NonLocalStorage.ts:153

getItems

getItems(names: string[]): Promise<undefined | ItemsType>
Retrieve multiple values by key.
Parameters
- names: string[]
  Array of key names.
Returns Promise<undefined | ItemsType>
Object of items found.
- Defined in NonLocalStorage.ts:198

getAllItems

getAllItems(options?: { prefix?: string }): Promise<undefined | ItemsType>
Retrieve all items, optionally filtered by prefix.
Parameters
- Optionaloptions: { prefix?: string }
  Optional prefix filter.
Returns Promise<undefined | ItemsType>
Object of all items.
- Defined in NonLocalStorage.ts:263

getAllKeys

getAllKeys(options?: { prefix?: string }): Promise<undefined | string[]>
Get all keys, optionally filtered by prefix.
Parameters
- Optionaloptions: { prefix?: string }
  Optional prefix filter.
Returns Promise<undefined | string[]>
Array of key names.
- Defined in NonLocalStorage.ts:305

removeItem

removeItem(name: string): Promise<undefined>
Remove a value by key.
Parameters
- name: string
  The key name.
Returns Promise<undefined>
- Defined in NonLocalStorage.ts:314

removeItems

removeItems(names: string[]): Promise<undefined>
Remove multiple values by key.
Parameters
- names: string[]
  Array of key names.
Returns Promise<undefined>
- Defined in NonLocalStorage.ts:324

incrementItem

incrementItem(
    name: string,
    value?: number,
    options?: { ttl?: number; updatedAt?: number },
): Promise<ItemType>
Atomically increment a numeric value.
Parameters
- name: string
  The key name.
- value: number = 1
  Amount to increment by (default 1).
- Optionaloptions: { ttl?: number; updatedAt?: number }
  Optional overrides.
  - Optionalttl?: number
    Time-to-live in milliseconds for this item.
  - OptionalupdatedAt?: number
    If provided, the operation will only succeed if the remote item's updatedAt timestamp matches this value.
Returns Promise<ItemType>
The updated item.
Default
```
3600000 (1 hour)
```
Default
```
undefined
```
- Defined in NonLocalStorage.ts:341

decrementItem

decrementItem(
    name: string,
    value?: number,
    options?: { ttl?: number; updatedAt?: number },
): Promise<ItemType>
Atomically decrement a numeric value.
Parameters
- name: string
  The key name.
- value: number = 1
  Amount to decrement by (default 1).
- Optionaloptions: { ttl?: number; updatedAt?: number }
  Optional overrides.
  - Optionalttl?: number
    Time-to-live in milliseconds for this item.
  - OptionalupdatedAt?: number
    If provided, the operation will only succeed if the remote item's updatedAt timestamp matches this value.
Returns Promise<ItemType>
The updated item.
Default
```
3600000 (1 hour)
```
Default
```
undefined
```
- Defined in NonLocalStorage.ts:371

push

push(
    name: string,
    element: ValueType,
    options?: { ttl?: number; updatedAt?: number },
): Promise<ItemType>
Atomically adds an element to an item that is an array. If the item does not exist, it will be created as a new array.
Parameters
- name: string
  The key of the array item.
- element: ValueType
  The element to push to the array.
- Optionaloptions: { ttl?: number; updatedAt?: number }
  Optional overrides.
  - Optionalttl?: number
    Time-to-live in milliseconds for this item.
  - OptionalupdatedAt?: number
    If provided, the operation will only succeed if the remote item's updatedAt timestamp matches this value.
Returns Promise<ItemType>
The updated item metadata.
Default
```
3600000 (1 hour)
```
Default
```
undefined
```
- Defined in NonLocalStorage.ts:402

splice

splice(
    name: string,
    startIndex: number,
    deleteCount: number,
    items?: ValueType[],
    options?: { ttl?: number; updatedAt?: number },
): Promise<ItemType>
Atomically modifies an array item using splice semantics.
Parameters
- name: string
  The key of the array item.
- startIndex: number
  The index to start changing the array.
- deleteCount: number
  The number of elements to remove.
- Optionalitems: ValueType[]
  Optional array of elements to add.
- Optionaloptions: { ttl?: number; updatedAt?: number }
  Optional overrides.
  - Optionalttl?: number
    Time-to-live in milliseconds for this item.
  - OptionalupdatedAt?: number
    If provided, the operation will only succeed if the remote item's updatedAt timestamp matches this value.
Returns Promise<ItemType>
The updated item metadata.
Default
```
3600000 (1 hour)
```
Default
```
undefined
```
- Defined in NonLocalStorage.ts:431

merge

merge(
    name: string,
    objectToMerge: ValueType,
    options?: { ttl?: number; updatedAt?: number },
): Promise<ItemType>
Atomically merges fields from a given object into an existing JSON object. If the item does not exist, it will be created.
Parameters
- name: string
  The key of the object item.
- objectToMerge: ValueType
  The object containing fields to merge.
- Optionaloptions: { ttl?: number; updatedAt?: number }
  Optional overrides.
  - Optionalttl?: number
    Time-to-live in milliseconds for this item.
  - OptionalupdatedAt?: number
    If provided, the operation will only succeed if the remote item's updatedAt timestamp matches this value.
Returns Promise<ItemType>
The updated item metadata.
Default
```
3600000 (1 hour)
```
Default
```
undefined
```
- Defined in NonLocalStorage.ts:471

setIn

setIn(
    name: string,
    path: string | string[],
    value: ValueType,
    options?: { ttl?: number; updatedAt?: number },
): Promise<ItemType>
Atomically sets a value deep within a nested JSON object using a path.
Parameters
- name: string
  The key of the object item.
- path: string | string[]
  A dot notation string (e.g., "user.profile.name") or an array of keys.
- value: ValueType
  The value to set at the specified path.
- Optionaloptions: { ttl?: number; updatedAt?: number }
  Optional overrides.
  - Optionalttl?: number
    Time-to-live in milliseconds for this item.
  - OptionalupdatedAt?: number
    If provided, the operation will only succeed if the remote item's updatedAt timestamp matches this value.
Returns Promise<ItemType>
The updated item metadata.
Default
```
3600000 (1 hour)
```
Default
```
undefined
```
- Defined in NonLocalStorage.ts:499

clear

clear(): Promise<undefined>
Remove all items for this instance.

Returns Promise<undefined>
- Defined in NonLocalStorage.ts:519

send

send(
    msg: JSONObj,
    options?: {
        transport?: "ws" | "http";
        auth?: { userIdSignature?: string; identityToken?: string };
    },
): Promise<undefined>
Send a message to the server or other clients.
Parameters
- msg: JSONObj
  The message object to send.
- options: {
  transport?: "ws" | "http";
  auth?: { userIdSignature?: string; identityToken?: string };
  } = ...
  Transport and authentication options.
  - Optionaltransport?: "ws" | "http"
    Transport method: 'ws' (WebSocket) or 'http'. Defaults to 'ws'.
  - Optionalauth?: { userIdSignature?: string; identityToken?: string }
    Optional authentication credentials for user verification.
    
    OptionaluserIdSignature?: string
    The signature for Mode 3 user verification.
    
    OptionalidentityToken?: string
    The JWT token for Mode 2 user verification.
Returns Promise<undefined>
Throws
Error if encryption is configured but getEncryptionSettings() not called.
Remarks
- If transport: 'ws' (WebSocket), the message is delivered to other clients but not echoed back to the sender. The sender will not receive their own message via on('message').
- If transport: 'http', the message is delivered to all clients including the sender. The sender will receive their own message via on('message').
- Messages are automatically encrypted if encryption is configured.
- WebSocket transport is preferred for real-time delivery, but HTTP can be used as fallback.
- User ID signature verification will not work with encrypted payloads or non-string payloads.
- When using userIdSignature, the userId should also be provided for proper verification.
Example
```
// Message sent via WebSocket (not received by sender)
await instance.send({ type: 'chat', message: 'Hello!' });

// Message sent via HTTP (received by sender)
await instance.send({ type: 'chat', message: 'Hello!' }, { transport: 'http' });

// Send with Mode 2 user authentication
await instance.send(
  { type: 'chat', message: 'Hello!', userId: '1234 },
  {
    transport: 'ws',
    auth: { identityToken: 'jwt-token-here' }
  }
);

// Send with Mode 3 user authentication
await instance.send(
  { type: 'chat', message: 'Hello!', userId: '1234 },
  {
    transport: 'ws',
    auth: {
      userIdSignature: 'signature123'
    }
  }
);
```
Inherited from WebSocketFunctions.send
- Defined in Ws.ts:216

on

on(event: "connect", handler: () => void): any
Register an event handler for WebSocket connection events.
Parameters
- event: "connect"
  The 'connect' event name.
- handler: () => void
  Function to call when connected.
Returns any
Inherited from WebSocketFunctions.on
- Defined in Ws.ts:270
on(event: "disconnect", handler: () => void): any
Register an event handler for WebSocket disconnection events.
Parameters
- event: "disconnect"
  The 'disconnect' event name.
- handler: () => void
  Function to call when disconnected.
Returns any
Inherited from WebSocketFunctions.on
- Defined in Ws.ts:276
on(
event: "presence:join",
handler: (joinedConnection: JoinedConnection) => void,
): any
Register an event handler for presence join events.
Parameters
- event: "presence:join"
  The 'presence:join' event name.
- handler: (joinedConnection: JoinedConnection) => void
  Function to call when a connection joins.
Returns any
Inherited from WebSocketFunctions.on
- Defined in Ws.ts:282
on(
event: "presence:leave",
handler: (leavedConnection: LeavedConnection) => void,
): any
Register an event handler for presence leave events.
Parameters
- event: "presence:leave"
  The 'presence:leave' event name.
- handler: (leavedConnection: LeavedConnection) => void
  Function to call when a connection leaves.
Returns any
Inherited from WebSocketFunctions.on
- Defined in Ws.ts:288
on(event: "message", handler: (data: JSONObj) => void): any
Register an event handler for incoming messages.
Parameters
- event: "message"
  The 'message' event name.
- handler: (data: JSONObj) => void
  Function to call when a message is received.
Returns any
Inherited from WebSocketFunctions.on
- Defined in Ws.ts:294
on(event: "error", handler: (error: Error) => void): any
Register an event handler for WebSocket errors.
Parameters
- event: "error"
  The 'error' event name.
- handler: (error: Error) => void
  Function to call when an error occurs.
Returns any
Inherited from WebSocketFunctions.on
- Defined in Ws.ts:300
on(event: "setItem", handler: (item: ItemType & { prop: string }) => void): any
Register an event handler for all setItem events.
Parameters
- event: "setItem"
  The 'setItem' event name.
- handler: (item: ItemType & { prop: string }) => void
  Function to call when any item is set.
Returns any
Inherited from WebSocketFunctions.on
- Defined in Ws.ts:306
on(
    event: "setItem",
    name: string,
    handler: (item: ItemType & { prop: string }) => void,
): any
Register an event handler for specific setItem events.
Parameters
- event: "setItem"
  The 'setItem' event name.
- name: string
  The specific item name to listen for.
- handler: (item: ItemType & { prop: string }) => void
  Function to call when the named item is set.
Returns any
Inherited from WebSocketFunctions.on
- Defined in Ws.ts:313
on(event: "removeItem", handler: (item: { prop: string }) => void): any
Register an event handler for all removeItem events.
Parameters
- event: "removeItem"
  The 'removeItem' event name.
- handler: (item: { prop: string }) => void
  Function to call when any item is removed.
Returns any
Inherited from WebSocketFunctions.on
- Defined in Ws.ts:319
on(
    event: "removeItem",
    name: string,
    handler: (item: { prop: string }) => void,
): any
Register an event handler for specific removeItem events.
Parameters
- event: "removeItem"
  The 'removeItem' event name.
- name: string
  The specific item name to listen for.
- handler: (item: { prop: string }) => void
  Function to call when the named item is removed.
Returns any
Inherited from WebSocketFunctions.on
- Defined in Ws.ts:326

off

off(event: "connect", handler: () => void): any
Remove an event handler for WebSocket connection events.
Parameters
- event: "connect"
  The 'connect' event name.
- handler: () => void
  Function to remove.
Returns any
Inherited from WebSocketFunctions.off
- Defined in Ws.ts:635
off(event: "disconnect", handler: () => void): any
Remove an event handler for WebSocket disconnection events.
Parameters
- event: "disconnect"
  The 'disconnect' event name.
- handler: () => void
  Function to remove.
Returns any
Inherited from WebSocketFunctions.off
- Defined in Ws.ts:641
off(
event: "presence:join",
handler: (joinedConnection: JoinedConnection) => void,
): any
Remove an event handler for presence join events.
Parameters
- event: "presence:join"
  The 'presence:join' event name.
- handler: (joinedConnection: JoinedConnection) => void
  Function to remove.
Returns any
Inherited from WebSocketFunctions.off
- Defined in Ws.ts:647
off(
event: "presence:leave",
handler: (leavedConnection: LeavedConnection) => void,
): any
Remove an event handler for presence leave events.
Parameters
- event: "presence:leave"
  The 'presence:leave' event name.
- handler: (leavedConnection: LeavedConnection) => void
  Function to remove.
Returns any
Inherited from WebSocketFunctions.off
- Defined in Ws.ts:653
off(event: "message", handler: (data: JSONObj) => void): any
Remove an event handler for incoming messages.
Parameters
- event: "message"
  The 'message' event name.
- handler: (data: JSONObj) => void
  Function to remove.
Returns any
Inherited from WebSocketFunctions.off
- Defined in Ws.ts:659
off(event: "error", handler: (error: Error) => void): any
Remove an event handler for WebSocket errors.
Parameters
- event: "error"
  The 'error' event name.
- handler: (error: Error) => void
  Function to remove.
Returns any
Inherited from WebSocketFunctions.off
- Defined in Ws.ts:665
off(event: "setItem", handler: (item: ItemType & { prop: string }) => void): any
Remove an event handler for all setItem events.
Parameters
- event: "setItem"
  The 'setItem' event name.
- handler: (item: ItemType & { prop: string }) => void
  Function to remove.
Returns any
Inherited from WebSocketFunctions.off
- Defined in Ws.ts:671
off(
    event: "setItem",
    name: string,
    handler: (item: ItemType & { prop: string }) => void,
): any
Remove an event handler for specific setItem events.
Parameters
- event: "setItem"
  The 'setItem' event name.
- name: string
  The specific item name.
- handler: (item: ItemType & { prop: string }) => void
  Function to remove.
Returns any
Inherited from WebSocketFunctions.off
- Defined in Ws.ts:678
off(event: "removeItem", handler: (item: { prop: string }) => void): any
Remove an event handler for all removeItem events.
Parameters
- event: "removeItem"
  The 'removeItem' event name.
- handler: (item: { prop: string }) => void
  Function to remove.
Returns any
Inherited from WebSocketFunctions.off
- Defined in Ws.ts:684
off(
    event: "removeItem",
    name: string,
    handler: (item: { prop: string }) => void,
): any
Remove an event handler for specific removeItem events.
Parameters
- event: "removeItem"
  The 'removeItem' event name.
- name: string
  The specific item name.
- handler: (item: { prop: string }) => void
  Function to remove.
Returns any
Inherited from WebSocketFunctions.off
- Defined in Ws.ts:691

connect

connect(): Promise<void>
Opens the WebSocket connection.

Returns Promise<void>
Remarks
Does usually not need to be used, since the WebSocke connection is automatically established on WS feature usage.
Inherited from WebSocketFunctions.connect
- Defined in Ws.ts:806

disconnect

disconnect(): Promise<void>
Close the WebSocket connection and clean up resources.

Returns Promise<void>
Remarks
If the instance has joined the presence channel, it will automatically leave before disconnecting. This ensures proper cleanup and notifies other clients of the departure. All event handlers are also cleaned up.
Inherited from WebSocketFunctions.disconnect
- Defined in Ws.ts:819

join

join(
data: JSONObj,
auth?: { userIdSignature?: string; identityToken?: string },
): Promise<undefined>
Join the presence channel to announce this connection to others.
Parameters
- data: JSONObj
  Optional data to associate with this connection.
- Optionalauth: { userIdSignature?: string; identityToken?: string }
  Optional object containing authentication credentials.
  - OptionaluserIdSignature?: string
    The signature for Mode 3 verification.
  - OptionalidentityToken?: string
    The JWT for Mode 2 verification.
Returns Promise<undefined>
Throws
Error if encryption is configured but getEncryptionSettings() not called.
Remarks
After joining, this connection will:
- Appear in getJoinedConnections() results for other clients
- Trigger 'presence:join' events for other connected clients
- Automatically send 'presence:leave' when disconnecting
Example
```
await instance.join({
  username: 'Alice',
  status: 'online',
  avatar: 'avatar1.png'
});
```
Inherited from WebSocketFunctions.join
- Defined in Ws.ts:1310

leave

leave(): Promise<undefined>
Leave the presence channel.

Returns Promise<undefined>
Remarks
Notifies other connected clients that this connection has left. This is automatically called when disconnecting if the connection had previously joined.
Inherited from WebSocketFunctions.leave
- Defined in Ws.ts:1388

getJoinedConnections

getJoinedConnections(): Promise<JoinedConnections>
Get a list of all currently connected clients in the presence channel.

Returns Promise<JoinedConnections>
Promise resolving to an array of connected clients with their data.
Throws
Error if encryption is configured but getEncryptionSettings() not called.
Remarks
Each connection object includes:
- connectionId: Unique identifier for the connection
- joinedAt: Timestamp when the connection joined
- data: Custom data provided when joining (automatically decrypted)
Your own connection always appears first in the list for convenience.
Example
```
const connections = await instance.getJoinedConnections();
console.log(`${connections.length} users online`);
const myConnection = connections[0]; // Always your connection
const otherUsers = connections.slice(1); // All other users
connections.forEach(conn => {
  console.log(`User: ${conn.data.username}, joined: ${new Date(conn.joinedAt)}`);
});
```
Inherited from WebSocketFunctions.getJoinedConnections
- Defined in Ws.ts:1475

Class NonLocalStorage

Remarks

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns NonLocalStorage

Parameters

Returns NonLocalStorage

Properties

id

Protected Readonlyttl

isConnected

OptionalconnectionId

Methods

StaticretrieveAccessToken

Parameters

Optionalorigin?: string

Returns Promise<string>

Example

useAccessToken

Parameters

Returns number

Remarks

onAccessTokenExpiring

Parameters

Returns void

offAccessTokenExpiring

Parameters

Returns void

getEncryptionSettings

Parameters

Returns Promise<EncryptionSettingsInfos>

Throws

Remarks

rotateEncryption

Parameters

Returns Promise<EncryptionSettingsInfos>

Throws

Remarks

setItem

Parameters

Optionalttl?: number

OptionalifAbsent?: boolean

OptionalupdatedAt?: number

Returns Promise<undefined | ItemType>

Default

Default

Default

setItems

Parameters

Returns Promise<undefined | ItemsType>

Default

Default

Default

getItem

Type Parameters

Parameters

Returns Promise<undefined | ItemType<T>>

getItems

Parameters

Returns Promise<undefined | ItemsType>

getAllItems

Parameters

Returns Promise<undefined | ItemsType>

getAllKeys

Parameters

Returns Promise<undefined | string[]>

removeItem

Parameters

Returns Promise<undefined>

removeItems

Parameters

Returns Promise<undefined>

incrementItem

Parameters

`Protected` `Readonly`ttl

`Optional`connectionId

`Static`retrieveAccessToken

`Optional`origin?: string

`Optional`ttl?: number

`Optional`ifAbsent?: boolean

`Optional`updatedAt?: number

`Optional`ttl?: number

`Optional`updatedAt?: number

`Optional`ttl?: number

`Optional`updatedAt?: number

`Optional`ttl?: number

`Optional`updatedAt?: number

`Optional`ttl?: number

`Optional`updatedAt?: number

`Optional`ttl?: number

`Optional`updatedAt?: number

`Optional`ttl?: number

`Optional`updatedAt?: number

`Optional`transport?: "ws" | "http"

`Optional`auth?: { userIdSignature?: string; identityToken?: string }

`Optional`userIdSignature?: string

`Optional`identityToken?: string