Connector | Machinat

Type parameters

User: null | MachinatUser

Hierarchy

Emitter<{ connect: any; disconnect: any; error: any; events: any }>
- Connector

Index

Constructors

constructor

new Connector<User>(serverUrl: string, login: ClientLoginFn<User, unknown>, marshaler: Marshaler): Connector<User>

Overrides Emitter<{ connect: (ctx: ConnectorContext<User>) => void; events: (events: EventInput[], ctx: ConnectorContext<User>) => void; disconnect: ( reason: { reason?: string }, ctx: ConnectorContext<User> ) => void; error: (err: Error) => void; }>.constructor
- Defined in packages/websocket/src/client/Connector.ts:56
Type parameters
- User: null | MachinatUser
Parameters
- serverUrl: string
- login: ClientLoginFn<User, unknown>
- marshaler: Marshaler
Returns Connector<User>

Properties

isClosed

isClosed: boolean

Methods

addListener

addListener<E>(event: E, listener: { connect: any; disconnect: any; error: any; events: any }[E]): Connector<User>

Inherited from Emitter.addListener
- Defined in node_modules/typed-emitter/index.d.ts:24
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- event: E
- listener: { connect: any; disconnect: any; error: any; events: any }[E]
Returns Connector<User>

close

close(code?: number, reason?: string): void

- Defined in packages/websocket/src/client/Connector.ts:146
Parameters
- Optional code: number
- Optional reason: string
Returns void

connect

connect(): void

- Defined in packages/websocket/src/client/Connector.ts:78
Returns void

emit

emit<E>(event: E, ...args: Arguments<{ connect: any; disconnect: any; error: any; events: any }[E]>): boolean

Inherited from Emitter.emit
- Defined in node_modules/typed-emitter/index.d.ts:34
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- event: E
- Rest ...args: Arguments<{ connect: any; disconnect: any; error: any; events: any }[E]>
Returns boolean

eventNames

eventNames(): (string | symbol)[]

Inherited from Emitter.eventNames
- Defined in node_modules/typed-emitter/index.d.ts:35
Returns (string | symbol)[]

getMaxListeners

getMaxListeners(): number

Inherited from Emitter.getMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:40
Returns number

isConnected

isConnected(): boolean

- Defined in packages/websocket/src/client/Connector.ts:74
Returns boolean

listenerCount

listenerCount<E>(event: E): number

Inherited from Emitter.listenerCount
- Defined in node_modules/typed-emitter/index.d.ts:38
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- event: E
Returns number

listeners

listeners<E>(event: E): Function[]

Inherited from Emitter.listeners
- Defined in node_modules/typed-emitter/index.d.ts:37
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- event: E
Returns Function[]

off

off<E>(event: E, listener: { connect: any; disconnect: any; error: any; events: any }[E]): Connector<User>

Inherited from Emitter.off
- Defined in node_modules/typed-emitter/index.d.ts:30
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- event: E
- listener: { connect: any; disconnect: any; error: any; events: any }[E]
Returns Connector<User>

on

on<E>(event: E, listener: { connect: any; disconnect: any; error: any; events: any }[E]): Connector<User>

Inherited from Emitter.on
- Defined in node_modules/typed-emitter/index.d.ts:25
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- event: E
- listener: { connect: any; disconnect: any; error: any; events: any }[E]
Returns Connector<User>

once

once<E>(event: E, listener: { connect: any; disconnect: any; error: any; events: any }[E]): Connector<User>

Inherited from Emitter.once
- Defined in node_modules/typed-emitter/index.d.ts:26
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- event: E
- listener: { connect: any; disconnect: any; error: any; events: any }[E]
Returns Connector<User>

prependListener

prependListener<E>(event: E, listener: { connect: any; disconnect: any; error: any; events: any }[E]): Connector<User>

Inherited from Emitter.prependListener
- Defined in node_modules/typed-emitter/index.d.ts:27
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- event: E
- listener: { connect: any; disconnect: any; error: any; events: any }[E]
Returns Connector<User>

prependOnceListener

prependOnceListener<E>(event: E, listener: { connect: any; disconnect: any; error: any; events: any }[E]): Connector<User>

Inherited from Emitter.prependOnceListener
- Defined in node_modules/typed-emitter/index.d.ts:28
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- event: E
- listener: { connect: any; disconnect: any; error: any; events: any }[E]
Returns Connector<User>

rawListeners

rawListeners<E>(event: E): Function[]

Inherited from Emitter.rawListeners
- Defined in node_modules/typed-emitter/index.d.ts:36
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- event: E
Returns Function[]

removeAllListeners

removeAllListeners<E>(event?: E): Connector<User>

Inherited from Emitter.removeAllListeners
- Defined in node_modules/typed-emitter/index.d.ts:31
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- Optional event: E
Returns Connector<User>

removeListener

removeListener<E>(event: E, listener: { connect: any; disconnect: any; error: any; events: any }[E]): Connector<User>

Inherited from Emitter.removeListener
- Defined in node_modules/typed-emitter/index.d.ts:32
Type parameters
- E: "connect" | "events" | "disconnect" | "error"
Parameters
- event: E
- listener: { connect: any; disconnect: any; error: any; events: any }[E]
Returns Connector<User>

send

send(events: EventInput[]): Promise<void>

- Defined in packages/websocket/src/client/Connector.ts:119
Parameters
- events: EventInput[]
Returns Promise<void>

setMaxListeners

setMaxListeners(maxListeners: number): Connector<User>

Inherited from Emitter.setMaxListeners
- Defined in node_modules/typed-emitter/index.d.ts:41
Parameters
- maxListeners: number
Returns Connector<User>

Type parameters

User: null | MachinatUser

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

User: null | MachinatUser

Parameters

serverUrl: string

login: ClientLoginFn<User, unknown>

marshaler: Marshaler

Returns Connector<User>

Properties

isClosed

Methods

addListener

Type parameters

E: "connect" | "events" | "disconnect" | "error"

Parameters

event: E

listener: { connect: any; disconnect: any; error: any; events: any }[E]

Returns Connector<User>

close

Parameters

Optional code: number

Optional reason: string

Returns void

connect

Returns void

emit

Type parameters

E: "connect" | "events" | "disconnect" | "error"

Parameters

event: E

Rest ...args: Arguments<{ connect: any; disconnect: any; error: any; events: any }[E]>

Returns boolean

eventNames

Returns (string | symbol)[]

getMaxListeners

Returns number

isConnected

Returns boolean

listenerCount

Type parameters

E: "connect" | "events" | "disconnect" | "error"

Parameters

event: E

Returns number

listeners

Type parameters

E: "connect" | "events" | "disconnect" | "error"

Parameters

event: E

Returns Function[]

off

Type parameters

E: "connect" | "events" | "disconnect" | "error"

Parameters

event: E

listener: { connect: any; disconnect: any; error: any; events: any }[E]

Returns Connector<User>

on

Type parameters

E: "connect" | "events" | "disconnect" | "error"

Parameters

event: E

listener: { connect: any; disconnect: any; error: any; events: any }[E]

Returns Connector<User>

once

Type parameters

E: "connect" | "events" | "disconnect" | "error"

Parameters

event: E

listener: { connect: any; disconnect: any; error: any; events: any }[E]

Returns Connector<User>

prependListener