Skip to content

sessions / Exports / SessionImpl

Class: SessionImpl

Improved Session Implementation

Uses state machine pattern and pure functions for better maintainability

Implements

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new SessionImpl(userId, config?): SessionImpl

Parameters

NameType
userIdstring
configSessionConfig

Returns

SessionImpl

Defined in

packages/sessions/src/session/session-impl.ts:47

Properties

metadata

Readonly metadata: SessionMetadata

Implementation of

Session.metadata

Defined in

packages/sessions/src/session/session-impl.ts:40


config

Readonly config: SessionConfig

Implementation of

Session.config

Defined in

packages/sessions/src/session/session-impl.ts:41

Methods

createNewChat

createNewChat(config?): Promise<ChatInstance>

Parameters

NameType
config?ChatConfig

Returns

Promise<ChatInstance>

Implementation of

Session.createNewChat

Defined in

packages/sessions/src/session/session-impl.ts:67


getChat

getChat(chatId): undefined | ChatInstance

Parameters

NameType
chatIdstring

Returns

undefined | ChatInstance

Implementation of

Session.getChat

Defined in

packages/sessions/src/session/session-impl.ts:94


getAllChats

getAllChats(): ChatInstance[]

Returns

ChatInstance[]

Implementation of

Session.getAllChats

Defined in

packages/sessions/src/session/session-impl.ts:98


switchToChat

switchToChat(chatId): Promise<void>

Parameters

NameType
chatIdstring

Returns

Promise<void>

Implementation of

Session.switchToChat

Defined in

packages/sessions/src/session/session-impl.ts:102


removeChat

removeChat(chatId): Promise<void>

Parameters

NameType
chatIdstring

Returns

Promise<void>

Implementation of

Session.removeChat

Defined in

packages/sessions/src/session/session-impl.ts:114


getActiveChat

getActiveChat(): undefined | ChatInstance

Returns

undefined | ChatInstance

Implementation of

Session.getActiveChat

Defined in

packages/sessions/src/session/session-impl.ts:139


pause

pause(): Promise<void>

Returns

Promise<void>

Implementation of

Session.pause

Defined in

packages/sessions/src/session/session-impl.ts:147


resume

resume(): Promise<void>

Returns

Promise<void>

Implementation of

Session.resume

Defined in

packages/sessions/src/session/session-impl.ts:152


archive

archive(): Promise<void>

Returns

Promise<void>

Implementation of

Session.archive

Defined in

packages/sessions/src/session/session-impl.ts:164


terminate

terminate(): Promise<void>

Returns

Promise<void>

Implementation of

Session.terminate

Defined in

packages/sessions/src/session/session-impl.ts:169


save

save(): Promise<void>

Returns

Promise<void>

Implementation of

Session.save

Defined in

packages/sessions/src/session/session-impl.ts:181


load

load(): Promise<void>

Returns

Promise<void>

Implementation of

Session.load

Defined in

packages/sessions/src/session/session-impl.ts:186


getState

getState(): SessionState

Returns

SessionState

Implementation of

Session.getState

Defined in

packages/sessions/src/session/session-impl.ts:191


updateConfig

updateConfig(config): void

Parameters

NameType
configPartial<SessionConfig>

Returns

void

Implementation of

Session.updateConfig

Defined in

packages/sessions/src/session/session-impl.ts:195


getStats

getStats(): SessionStats

Returns

SessionStats

Implementation of

Session.getStats

Defined in

packages/sessions/src/session/session-impl.ts:218

Released under the MIT License.