Interface IChannel<IEventsList>

Type parameters

IEventsList: IChannelEventsList

Hierarchy

INode<IEventsList>
- IChannel
  - Channel

Indexable

[key: string]: any

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IChannel(id?: string): any

Inherited from INode.__new
- Defined in ancient-channels/node_modules/ancient-mixins/lib/node.d.ts:11
Parameters
- Optional id: string
Returns any

Properties

emitter

emitter: EventEmitter

Optional getter

getter: IChannelGetter<any>

id

id: string

isDestroyed

isDestroyed: boolean

isReading

isReading: boolean

Methods

destroy

destroy(): void

Inherited from INode.destroy

Overrides IEvents.destroy
- Defined in ancient-channels/node_modules/ancient-mixins/lib/node.d.ts:15
Returns void

emit

emit<IE>(eventName: IE, data: IEventsList[IE]): this

Inherited from IEvents.emit
- Defined in ancient-channels/node_modules/ancient-mixins/lib/events.d.ts:6
Type parameters
- IE: keyof IEventsList
Parameters
- eventName: IE
- data: IEventsList[IE]
Returns this

generateId

generateId(): string

Inherited from INode.generateId
- Defined in ancient-channels/node_modules/ancient-mixins/lib/node.d.ts:13
Returns string

get

get(): Promise<any>

- Defined in ancient-channels/src/lib/channel.ts:30
Returns Promise<any>

got

got(data?: Promise<any> | any): void

- Defined in ancient-channels/src/lib/channel.ts:28
Parameters
- Optional data: Promise<any> | any
Returns void

off

off<IE>(eventName: IE, listener: function): this

Inherited from IEvents.off
- Defined in ancient-channels/node_modules/ancient-mixins/lib/events.d.ts:9
Type parameters
- IE: keyof IEventsList
Parameters
- eventName: IE
- listener: function
  - - (data: IEventsList[IE]): void
    - Parameters
      - data: IEventsList[IE]
      Returns void
Returns this

on

on<IE>(eventName: IE, listener: function): this

Inherited from IEvents.on
- Defined in ancient-channels/node_modules/ancient-mixins/lib/events.d.ts:7
Type parameters
- IE: keyof IEventsList
Parameters
- eventName: IE
- listener: function
  - - (data: IEventsList[IE]): void
    - Parameters
      - data: IEventsList[IE]
      Returns void
Returns this

once

once<IE>(eventName: IE, listener: function): this

Inherited from IEvents.once
- Defined in ancient-channels/node_modules/ancient-mixins/lib/events.d.ts:8
Type parameters
- IE: keyof IEventsList
Parameters
- eventName: IE
- listener: function
  - - (data: IEventsList[IE]): void
    - Parameters
      - data: IEventsList[IE]
      Returns void
Returns this

ready

ready(): void

- Defined in ancient-channels/src/lib/channel.ts:29
Returns void

Generated using TypeDoc