Reference / @open-music-sdk/user-token / MemoryUserTokenStore

Class: MemoryUserTokenStore

Defined in: user-token/src/stores.ts:7

Keeps tokens in a Map: for tests, scripts, and single-process servers. Everything is gone on restart.

Implements

• tUserTokenStore
• AsyncDisposable

Constructors

Constructor

new MemoryUserTokenStore(): MemoryUserTokenStore;

Returns

MemoryUserTokenStore

Methods

[asyncDispose]()

[asyncDispose](): Promise<void>;

Defined in: user-token/src/stores.ts:48

dispose(), for await using.

Returns

Promise<void>

Implementation of

AsyncDisposable.[asyncDispose]

---

delete()

delete(userId): Promise<void>;

Defined in: user-token/src/stores.ts:37

Forgets a user's token, if one is kept.

Parameters

userId

string

The id it was set under.

Returns

Promise<void>

Implementation of

tUserTokenStore.delete

---

dispose()

dispose(): void;

Defined in: user-token/src/stores.ts:43

Forgets every token: the Map is all this store holds.

Returns

void

---

get()

get(userId): Promise<string | undefined>;

Defined in: user-token/src/stores.ts:17

The token kept for a user.

Parameters

userId

string

The id the token was set under.

Returns

Promise<string | undefined>

The token, or undefined when none is kept.

Implementation of

tUserTokenStore.get

---

set()

set(userId, token): Promise<void>;

Defined in: user-token/src/stores.ts:27

Keeps a token for a user, in place of any kept before.

Parameters

userId

string

The id to keep it under: the app's own, as forUser() is given it.

token

string

The Music User Token.

Returns

Promise<void>

Implementation of

tUserTokenStore.set