Class TocketClientNode<S>

Readonly defaultCustomDataHandler

Readonly defaultIdentityHandler

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

getPromiseId

• getPromiseId(requestFilter): undefined | string

• Parameters

  • requestFilter: Partial<SocketRequest>

  Returns undefined | string

removeConnection

• removeConnection(name): boolean

• Removes a server connection from the client.

  Parameters

  • name: string

    The name of the Server

  Returns boolean

launch

genericMessageInterceptor

• genericMessageInterceptor(socket): TrapFunction

• Generics message interceptor

  Parameters

  • socket: SocketWrapper<S>

    The Socket to target.

  Returns TrapFunction

  Either the name of the Communication preset that processed the message or true.
  Used to decide if the message should be forwarded to the socket's default handling function if available.

getConnections

• getConnections(arg?): SocketWrapper<S>[]

• 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 SocketWrapper<S>[]

listPresets

• listPresets(): string[]

• List all registered communication presets

  Returns string[]

  Array of preset names

onInit

• onInit(): any

• Function to be executed when connection to the main webSocket is established

  Returns any

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.

registerSocket

• registerSocket(name, source, timeout?, initialized?, logging?): SocketWrapper<S>

• Registers socket

  Parameters

  • name: string

    the name of the targeted endpoint.

  • source: string | SocketLike

    WebSocket ws or wss URL

  • timeout: number = ...

    How long to wait for the endpoint to respond

  • Optional initialized: boolean

    Should the connection be initialized at a later time?

  • Optional logging: LoggingTypes

    which messages should be logged?

  Returns SocketWrapper<S>

  The created SocketWrapper

removeSocket

• removeSocket(name): boolean

• Removes a Socket from the TocketClientBase#connections map.

  Parameters

  • name: string

    The name of the connection to remove.

  Returns boolean

  true if the Socket was removed, false if it didn't exist.

clientID

timeout

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

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