IoAdapter

  
class IoAdapter extends AbstractWsAdapter {
  create(port: number, options?: ServerOptions & { namespace?: string; server?: any; }): Server
  createIOServer(port: number, options?: any): any
  bindMessageHandlers(socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>, handlers: MessageMappingProperties[], transform: (data: any) => Observable<any>)
  mapPayload(payload: unknown): {...}
}

Methods

create()


create(port: number, options?: ServerOptions & { namespace?: string; server?: any; }): Server

Parameters

Option Type Description
port number
options ServerOptions & { namespace?: string; server?: any; }

Optional. Default is undefined.

Returns

Server

createIOServer()


createIOServer(port: number, options?: any): any

Parameters

Option Type Description
port number
options any

Optional. Default is undefined.

Returns

any

bindMessageHandlers()


bindMessageHandlers(socket: Socket<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>, handlers: MessageMappingProperties[], transform: (data: any) => Observable<any>)

Parameters

Option Type Description
socket Socket
handlers MessageMappingProperties[]
transform (data: any) => Observable

mapPayload()


mapPayload(payload: unknown): {
    data: any;
    ack?: Function;
}

Parameters

Option Type Description
payload unknown

Returns

{ data: any; ack?: Function; }