Class TocketServer<S>

The Server instance of Tocket. Meant to run in Node, not in the browser.

Type Parameters

S extends SocketDefinition = DefaultSocket

Definition object for the functionality of the Socket.

Hierarchy

TocketBase<"Server", S>
- TocketServer

constructor

new TocketServer<S>(port, data?, server?, timeout?, keepDateTimeStrings?): TocketServer<S>
Creates an instance of the Tocket SocketServer.
Type Parameters
- S extends SocketDefinition = DefaultSocket
Parameters
- port: number
  
  the Port the WebSocket will be listening on.
- data: {
  [K in string]: Serializable
  } = ...
  
  an Object of custom data that will be made accessible to all endpoints
- Optional server: Server<typeof IncomingMessage, typeof ServerResponse>
  
  If you are using an https server you can inject it here.
- timeout: number = 1500
  
  number of milliseconds to wait for an endpoint to answer a message
- keepDateTimeStrings: boolean = true
  
  by default ISO datetime strings will automatically be parsed into Date objects, set to false to disable this behavior.
Returns TocketServer<S>
Overrides TocketBase.constructor
- Defined in server/TocketServer.ts:19

`Private` `Readonly` keepDateTimeStrings

keepDateTimeStrings: boolean = true

by default ISO datetime strings will automatically be parsed into Date objects, set to false to disable this behavior.

getCustomData

getCustomData<K>(key?): K extends Sk<S["data"] & {
        id: string;
    }>
    ? (S["data"] & {
        id: string;
    })[K]
    : S["data"]
Access the CustomData object of this Socket.
Type Parameters
- K extends string
Parameters
- Optional key: K
  
  The key of the CustomData property to fetch. If left out the entire CustomData Object is returned.
Returns K extends Sk<S["data"] & {
        id: string;
    }>
    ? (S["data"] & {
        id: string;
    })[K]
    : S["data"]
Either the content of the CustomData property or the CustomData Object
Inherited from TocketBase.getCustomData
- Defined in base/TocketBase.ts:201

getPromiseId

getPromiseId(requestFilter): undefined | string
Parameters
- requestFilter: Partial<SocketRequest>
Returns undefined | string
Inherited from TocketBase.getPromiseId
- Defined in base/TocketBase.ts:60

Primary Controls

launch

launch: SocketMethods<S> = ...

getConnections

getConnections(arg?): ClientWrapper[]
Fetch all or a subset of current connections of the Socket, optionally narrowed by a filter.
Parameters
- Optional arg: ConnectionFilter<NonNullable<Connector<S>>>
  
  a Filter for the connections to be fetched. If left empty, all connections are returned.
Returns ClientWrapper[]
Inherited from TocketBase.getConnections
- Defined in base/TocketBase.ts:173

listPresets

listPresets(): string[]
List all registered communication presets

Returns string[]
Array of preset names
Inherited from TocketBase.listPresets
- Defined in base/TocketBase.ts:80

register

register<N>(name, handlerName?, defaultTarget?, timeout?): Communication<S["presets"][N], NonNullable<Connector<S>>>
Registers a communication preset.
Type Parameters
- N extends string
Parameters
- name: N
  
  identifier of this preset.
- Optional handlerName: string
  
  name of the handler function on the target Socket this should process the messages
- Optional defaultTarget: ConnectionFilter<NonNullable<Connector<S>>>
  
  identifier of the Socket the communication should target. uses the 'main' socket by default
- timeout: number = ...
Returns Communication<S["presets"][N], NonNullable<Connector<S>>>
the generated Communication preset.
Inherited from TocketBase.register
- Defined in base/TocketBase.ts:211

General Properties

clientID

clientID: undefined | string = undefined

Client id generated by the server, empty in the Base and Server versions of the class

`Protected` customData

customData: {
[K in string]: Serializable
} = ...

timeout

timeout: number = 1500

Internal Methods

`Readonly` defaultCustomDataHandler

defaultCustomDataHandler: ((handler) => any)

Type declaration

- (handler): any
- Placeholder for the default custom Data method
  Parameters
  - handler: any
    
    The handler function
  Returns any

`Readonly` defaultIdentityHandler

defaultIdentityHandler: ((handler) => any)

Type declaration

- (handler): any
- Placeholder for the default identity method
  Parameters
  - handler: any
    
    The handler function
  Returns any

`Protected` _launch

_launch<N>(name, content?, targetFilter?): DefBack<S, N, "returns">
Launch a previously registered communication preset.
Type Parameters
- N extends string
Parameters
- name: N
  
  the name of the communication preset to start
- Optional content: DefBack<S, N, "content">
  
  the data used to initialize the connection.
- Optional targetFilter: ConnectionFilter<NonNullable<Connector<S>>>
  
  the identifier of the endpoint this should receive this message
Returns DefBack<S, N, "returns">
Inherited from TocketBase._launch
- Defined in base/TocketBase.ts:225

convertData

convertData(data): SocketRequest
Stringify Received Data
Parameters
- data: Data
  
  The Received Data
Returns SocketRequest
- Defined in server/TocketServer.ts:89

generateInterface

generateInterface<N>(presetName, handler, initialTarget, pID?): Handler<S["presets"][N], NonNullable<Connector<S>>>
Providing the communication method with smart and typed parameter functions.
Type Parameters
- N extends string
Parameters
- presetName: N
  
  Name of preset
- handler: Extract<keyof S["presets"], string>
  
  handler name
- initialTarget: ConnectionFilter<NonNullable<Connector<S>>>
  
  targetName
- Optional pID: string
  
  PID instance
Returns Handler<S["presets"][N], NonNullable<Connector<S>>>
The finished method handler
Inherited from TocketBase.generateInterface
- Defined in base/TocketBase.ts:122

`Protected` makeUUID

makeUUID(): string
Generates a UUID using the node-uuid package.

Returns string
secure UUID
Overrides TocketBase.makeUUID
- Defined in server/TocketServer.ts:119

`Private` onmessage

onmessage(message): void
Basic message handling.
Parameters
- message: Data
  
  the message received by the Socket.
Returns void
- Defined in server/TocketServer.ts:105

setCustomData

setCustomData(property, value): void
Modifies custom data on a Socket or Client. All connected Sockets and Clients receive the change immediately.
Parameters
- property: Extract<keyof S["data"], string>
  
  name of the property to set
- value: Serializable
  
  new value of the property
Returns void
Inherited from TocketBase.setCustomData
- Defined in base/TocketBase.ts:192

Internal Data

`Protected` connections

connections: Map<string, ClientWrapper> = ...

`Protected` presets

presets: {
[K in string]: Communication<S["presets"][K], NonNullable<Connector<S>>>
} = ...

Map holding all communication presets registered to the Socket

`Protected` promiseMap

promiseMap: Map<string, PromiseData> = ...

Class TocketServer<S>

Type Parameters

S extends SocketDefinition = DefaultSocket

Hierarchy

Index

Primary Controls

General Properties

Internal Methods

Internal Data

constructor

Type Parameters

S extends SocketDefinition = DefaultSocket

Parameters

port: number

data: { [K in string]: Serializable} = ...

Optional server: Server<typeof IncomingMessage, typeof ServerResponse>

timeout: number = 1500

keepDateTimeStrings: boolean = true

Returns TocketServer<S>

Private Readonly keepDateTimeStrings

getCustomData

Type Parameters

K extends string

Parameters

Optional key: K

Returns K extends Sk<S["data"] & { id: string; }> ? (S["data"] & { id: string; })[K] : S["data"]

getPromiseId

Parameters

requestFilter: Partial<SocketRequest>

Returns undefined | string

Primary Controls

launch

getConnections

Parameters

Optional arg: ConnectionFilter<NonNullable<Connector<S>>>

Returns ClientWrapper[]

listPresets

Returns string[]

register

Type Parameters

N extends string

Parameters

name: N

Optional handlerName: string

Optional defaultTarget: ConnectionFilter<NonNullable<Connector<S>>>

timeout: number = ...

Returns Communication<S["presets"][N], NonNullable<Connector<S>>>

General Properties

clientID

Protected customData

timeout

Internal Methods

Readonly defaultCustomDataHandler

Type declaration

Parameters

handler: any

Returns any

Readonly defaultIdentityHandler

Type declaration

Parameters

handler: any

Returns any

Protected _launch

Type Parameters

N extends string

Parameters

name: N

Optional content: DefBack<S, N, "content">

Optional targetFilter: ConnectionFilter<NonNullable<Connector<S>>>

Returns DefBack<S, N, "returns">

convertData

Parameters

data: Data

Returns SocketRequest

generateInterface

Type Parameters

N extends string

Parameters

presetName: N

handler: Extract<keyof S["presets"], string>

data: {
[K in string]: Serializable
} = ...

`Optional` server: Server<typeof IncomingMessage, typeof ServerResponse>

`Private` `Readonly` keepDateTimeStrings

`Optional` key: K

Returns K extends Sk<S["data"] & {
id: string;
}>
? (S["data"] & {
id: string;
})[K]
: S["data"]

`Optional` arg: ConnectionFilter<NonNullable<Connector<S>>>

`Optional` handlerName: string

`Optional` defaultTarget: ConnectionFilter<NonNullable<Connector<S>>>

`Protected` customData

`Readonly` defaultCustomDataHandler

`Readonly` defaultIdentityHandler

`Protected` _launch

`Optional` content: DefBack<S, N, "content">

`Optional` targetFilter: ConnectionFilter<NonNullable<Connector<S>>>

`Optional` pID: string

`Protected` makeUUID

`Private` onmessage

`Protected` connections

`Protected` presets

`Protected` promiseMap