Class Client

A client for Satori server.

Hierarchy

Client

Constructors

constructor

new Client(apiKey?: string, host?: string, port?: string, useSSL?: boolean, timeout?: number, autoRefreshSession?: boolean): Client
Parameters
- apiKey: string = DEFAULT_API_KEY
- host: string = DEFAULT_HOST
- port: string = DEFAULT_PORT
- useSSL: boolean = false
- timeout: number = DEFAULT_TIMEOUT_MS
- autoRefreshSession: boolean = true
Returns Client
- Defined in satori-js/client.ts:36

Properties

`Private` `Readonly` apiClient

apiClient: SatoriApi

The low level API client for Nakama server.

`Readonly` apiKey

apiKey: string = DEFAULT_API_KEY

`Readonly` autoRefreshSession

autoRefreshSession: boolean = true

expiredTimespanMs

expiredTimespanMs: number = DEFAULT_EXPIRED_TIMESPAN_MS

The expired timespan used to check session lifetime.

`Readonly` host

host: string = DEFAULT_HOST

`Readonly` port

port: string = DEFAULT_PORT

`Readonly` timeout

timeout: number = DEFAULT_TIMEOUT_MS

`Readonly` useSSL

useSSL: boolean = false

Methods

authenticate

authenticate(id: string, customProperties?: Record<string, string>, defaultProperties?: Record<string, string>): Promise<Session>
Authenticate a user with an ID against the server.
Parameters
- id: string
- Optional customProperties: Record<string, string>
- Optional defaultProperties: Record<string, string>
Returns Promise<Session>
- Defined in satori-js/client.ts:50

deleteIdentity

deleteIdentity(session: Session): Promise<boolean>
Delete the caller's identity and associated data.
Parameters
- session: Session
Returns Promise<boolean>
- Defined in satori-js/client.ts:278

deleteMessage

deleteMessage(session: Session, id: string): Promise<boolean>
Parameters
- session: Session
- id: string
Returns Promise<boolean>
- Defined in satori-js/client.ts:300

event

event(session: Session, event: ApiEvent): Promise<boolean>
Publish an event for this session.
Parameters
- session: Session
- event: ApiEvent
Returns Promise<boolean>
- Defined in satori-js/client.ts:89

events

events(session: Session, events: ApiEvent[]): Promise<boolean>
Publish multiple events for this session
Parameters
- session: Session
- events: ApiEvent[]
Returns Promise<boolean>
- Defined in satori-js/client.ts:105

getExperiments

getExperiments(session: Session, names?: string[]): Promise<ApiExperimentList>
Get or list all available experiments for this identity.
Parameters
- session: Session
- Optional names: string[]
Returns Promise<ApiExperimentList>
- Defined in satori-js/client.ts:121

getFlag

getFlag(session: Session, name: string): Promise<never>
Get a single flag for this identity. Throws an error when the flag does not exist.
Parameters
- session: Session
- name: string
Returns Promise<never>
- Defined in satori-js/client.ts:131

getFlagDefault

getFlagDefault(name: string): Promise<never>
Get a single flag with its configured default value. Throws an error when the flag does not exist.
Parameters
- name: string
Returns Promise<never>
- Defined in satori-js/client.ts:172

getFlagDefaultWithFallback

getFlagDefaultWithFallback(name: string, fallbackValue?: string): Promise<{
name: string;
value: undefined | string;
}>
Get a single flag with its configured default value.
Parameters
- name: string
- Optional fallbackValue: string
Returns Promise<{
name: string;
value: undefined | string;
}>
- Defined in satori-js/client.ts:191

getFlagWithFallback

getFlagWithFallback(session: Session, name: string, fallbackValue?: string): Promise<{
name: string;
value: undefined | string;
}>
Get a single flag for this identity.
Parameters
- session: Session
- name: string
- Optional fallbackValue: string
Returns Promise<{
name: string;
value: undefined | string;
}>
- Defined in satori-js/client.ts:156

getFlags

getFlags(session: Session, names?: string[]): Promise<ApiFlagList>
List all available flags for this identity.
Parameters
- session: Session
- Optional names: string[]
Returns Promise<ApiFlagList>
- Defined in satori-js/client.ts:207

getFlagsDefault

getFlagsDefault(names?: string[]): Promise<ApiFlagList>
List all available default flags.
Parameters
- Optional names: string[]
Returns Promise<ApiFlagList>
- Defined in satori-js/client.ts:217

getLiveEvents

getLiveEvents(session: Session, names?: string[]): Promise<ApiLiveEventList>
List available live events.
Parameters
- session: Session
- Optional names: string[]
Returns Promise<ApiLiveEventList>
- Defined in satori-js/client.ts:240

getMessageList

getMessageList(session: Session): Promise<boolean>
Parameters
- session: Session
Returns Promise<boolean>
- Defined in satori-js/client.ts:289

identify

identify(session: Session, id: string, defaultProperties?: Record<string, string>, customProperties?: Record<string, string>): Promise<Session>
Enrich/replace the current session with new identifier.
Parameters
- session: Session
- id: string
- Optional defaultProperties: Record<string, string>
- Optional customProperties: Record<string, string>
Returns Promise<Session>
- Defined in satori-js/client.ts:222

listProperties

listProperties(session: Session): Promise<ApiProperties>
List properties associated with this identity.
Parameters
- session: Session
Returns Promise<ApiProperties>
- Defined in satori-js/client.ts:250

logout

logout(session: Session): Promise<boolean>
Log out a session, invalidate a refresh token, or log out all sessions/refresh tokens for a user.
Parameters
- session: Session
Returns Promise<boolean>
- Defined in satori-js/client.ts:76

sessionRefresh

sessionRefresh(session: Session): Promise<Session>
Refresh a user's session using a refresh token retrieved from a previous authentication request.
Parameters
- session: Session
Returns Promise<Session>
- Defined in satori-js/client.ts:64

updateMessage

updateMessage(session: Session, id: string, consume_time?: string, read_time?: string): Promise<boolean>
Parameters
- session: Session
- id: string
- Optional consume_time: string
- Optional read_time: string
Returns Promise<boolean>
- Defined in satori-js/client.ts:311

updateProperties

updateProperties(session: Session, defaultProperties?: Record<string, string>, customProperties?: Record<string, string>, recompute?: boolean): Promise<boolean>
Update identity properties.
Parameters
- session: Session
- Optional defaultProperties: Record<string, string>
- Optional customProperties: Record<string, string>
- Optional recompute: boolean
Returns Promise<boolean>
- Defined in satori-js/client.ts:260

Class Client

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

apiKey: string = DEFAULT_API_KEY

host: string = DEFAULT_HOST

port: string = DEFAULT_PORT

useSSL: boolean = false

timeout: number = DEFAULT_TIMEOUT_MS

autoRefreshSession: boolean = true

Returns Client

Properties

Private Readonly apiClient

Readonly apiKey

Readonly autoRefreshSession

expiredTimespanMs

Readonly host

Readonly port

Readonly timeout

Readonly useSSL

Methods

authenticate

Parameters

id: string

Optional customProperties: Record<string, string>

Optional defaultProperties: Record<string, string>

Returns Promise<Session>

deleteIdentity

Parameters

session: Session

Returns Promise<boolean>

deleteMessage

Parameters

session: Session

id: string

Returns Promise<boolean>

event

Parameters

session: Session

event: ApiEvent

Returns Promise<boolean>

events

Parameters

session: Session

events: ApiEvent[]

Returns Promise<boolean>

getExperiments

Parameters

session: Session

Optional names: string[]

Returns Promise<ApiExperimentList>

getFlag

Parameters

session: Session

name: string

Returns Promise<never>

getFlagDefault

Parameters

name: string

Returns Promise<never>

getFlagDefaultWithFallback

Parameters

name: string

Optional fallbackValue: string

Returns Promise<{ name: string; value: undefined | string; }>

getFlagWithFallback

Parameters

session: Session

name: string

Optional fallbackValue: string

Returns Promise<{ name: string; value: undefined | string; }>

getFlags

Parameters

session: Session

Optional names: string[]

`Private` `Readonly` apiClient

`Readonly` apiKey

`Readonly` autoRefreshSession

`Readonly` host

`Readonly` port

`Readonly` timeout

`Readonly` useSSL

`Optional` customProperties: Record<string, string>

`Optional` defaultProperties: Record<string, string>

`Optional` names: string[]

`Optional` fallbackValue: string

Returns Promise<{
name: string;
value: undefined | string;
}>

`Optional` fallbackValue: string

Returns Promise<{
name: string;
value: undefined | string;
}>

`Optional` names: string[]

`Optional` names: string[]

`Optional` names: string[]

`Optional` defaultProperties: Record<string, string>

`Optional` customProperties: Record<string, string>

`Optional` consume_time: string

`Optional` read_time: string

`Optional` defaultProperties: Record<string, string>

`Optional` customProperties: Record<string, string>

`Optional` recompute: boolean