Class SessionId

A session ID A session ID

Hierarchy

SessionId

Index

Constructors

constructor

Properties

server
value

Methods

Constructors

constructor

new SessionId(server: Long, value: Long): SessionId

- Defined in internal/session/session-id.ts:22
Create a new session ID

Parameters
- server: Long
  
  server part of the ID
- value: Long
  
  value part of the ID
Returns SessionId

Properties

server

server: Long

Server part of the ID

value

value: Long

Value part of the ID

Methods

toString

toString(): string

- Defined in session.ts:34
Convert the session ID to a string

Returns string

a string representation of the session ID

Static fromString

fromString(str: string): SessionId

- Defined in internal/session/session-id.ts:41
Create a new session ID from a string

Parameters
- str: string
  
  the string representation of a session ID
Returns SessionId

a new session ID

Static validate

validate(str: string | SessionId): false | SessionId

- Defined in internal/session/session-id.ts:68
Determines if a given string is a valid SessionID. If true, the returned value will be the parsed SessionID

Parameters
- str: string | SessionId
  
  the session id string
Returns false | SessionId

false if the string cannot be parsed, or a constructed SessionID