This version (v0.7) has not been published to npm yet.
Skip to content

Reference / @getenginex/sdk/query / EnginexKeys

EnginexKeys ​

Prefixes of the SDK's query keys, to invalidate or remove whole groups from the cache.

Properties ​

all ​

readonly all: readonly ["enginex"]

['enginex']: everything the SDK keeps in the cache.


public ​

readonly public: readonly ["enginex", "public"]

['enginex', 'public']: data without a session (configuration, catalog).

Methods ​

user() ​

Call Signature ​

user(): readonly ["enginex", "user"]

['enginex', 'user']: data of all users (what to remove from the cache on logout or on a user switch).

Returns ​

readonly ["enginex", "user"]

Call Signature ​

user(userId): readonly ["enginex", "user", string]

['enginex', 'user', userId]: data of one user.

Parameters ​
userId ​

string

Returns ​

readonly ["enginex", "user", string]

Call Signature ​

user(userId, namespace): readonly ["enginex", "user", string, string]

['enginex', 'user', userId, namespace]: data of one user namespace (e.g. 'wallet').

Parameters ​
userId ​

string

namespace ​

string

Returns ​

readonly ["enginex", "user", string, string]

Call Signature ​

user(userId, namespace, method): readonly ["enginex", "user", string, string, string]

['enginex', 'user', userId, namespace, method]: data of one user method (e.g. 'getBalance').

Parameters ​
userId ​

string

namespace ​

string

method ​

string

Returns ​

readonly ["enginex", "user", string, string, string]