Class Connector

Hierarchy

Emitter
- Connector

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Connector(transceiver: Transceiver): Connector

- Defined in src/modules/Transceiver.ts:14
Parameters
- transceiver: Transceiver
Returns Connector

Properties

Private _connectors

_connectors: Connector[] = []

Private _transceiver

_transceiver: Transceiver

Methods

cemit

cemit(type: string, context: any, ...args: any[]): this

Inherited from Connector.cemit
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:43
Emit event with specifying a context.

Parameters
- type: string
  
  Event type to emit.
- context: any
  
  Context to execute the callback.
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns this

cemitAll

cemitAll(context: any, ...args: any[]): this

Inherited from Connector.cemitAll
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:57
Emit all events with specifying a context.

Parameters
- context: any
  
  Context to execute the callback.
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns this

clear

clear(type?: undefined | string): this

Inherited from Connector.clear
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:63
Remove events grouped event type.

Parameters
- Optional type: undefined | string
  
  Event type to remove. If it is empty, removes all events.
Returns this

connect

connect(connector: Connector): undefined | this

- Defined in src/modules/Transceiver.ts:44
Parameters
- connector: Connector
Returns undefined | this

disconnect

disconnect(connector: Connector): undefined | this

- Defined in src/modules/Transceiver.ts:57
Parameters
- connector: Connector
Returns undefined | this

disconnectAll

disconnectAll(): this

- Defined in src/modules/Transceiver.ts:70
Returns this

emit

emit(type: string, ...args: any[]): this

Inherited from Connector.emit
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:35
Emit event.

Parameters
- type: string
  
  Event type to emit.
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns this

emitAll

emitAll(...args: any[]): this

Inherited from Connector.emitAll
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:50
Emit all events.

Parameters
- Rest ...args: any[]
  
  Argument(s) in callback.
Returns this

getConnectors

getConnectors(): Connector[]

- Defined in src/modules/Transceiver.ts:22
Returns Connector[]

off

off(type: string, callback: IEmitterDelegate): this

Inherited from Connector.off
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:27
Unregister event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Registered callback.
Returns this

on

on(type: string, callback: IEmitterDelegate): this

Inherited from Connector.on
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:13
Register event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Callback when the event fires.
Returns this

once

once(type: string, callback: IEmitterDelegate): this

Inherited from Connector.once
- Defined in node_modules/@tawaship/emitter/types/modules/Emitter.d.ts:20
Register one-time event.

Parameters
- type: string
  
  Event type.
- callback: IEmitterDelegate
  
  Callback when the event fires.
Returns this

receive

receive(type: string, data: IReceiverData): undefined | this

- Defined in src/modules/Transceiver.ts:36
Parameters
- type: string
- data: IReceiverData
Returns undefined | this

send

send(type: string, data: any): void

- Defined in src/modules/Transceiver.ts:26
Parameters
- type: string
- data: any
Returns void

Generated using TypeDoc