Interface IClient<IN, IEventsList>

Type parameters

IN: TTracker
IEventsList: IClientEventsList

Hierarchy

IManager<IN, IEventsList>
- IClient
  - Client

Indexable

[key: string]: any

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IClient(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

List

List: TClass<IN>

Optional client

client: any

emitter

emitter: EventEmitter

id

id: string

isDestroyed

isDestroyed: boolean

isStarted

isStarted: boolean

Methods

add

add(node: IN): this

Inherited from IManager.add
- Defined in ancient-cursor/node_modules/ancient-mixins/lib/manager.d.ts:14
Parameters
- node: IN
Returns this

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

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

remove

remove(node: IN): this

Inherited from IManager.remove
- Defined in ancient-cursor/node_modules/ancient-mixins/lib/manager.d.ts:16
Parameters
- node: IN
Returns this

start

start(): Promise<void>

- Defined in ancient-tracker/src/lib/client.ts:35
Returns Promise<void>

starting

starting(): Promise<void>

- Defined in ancient-tracker/src/lib/client.ts:32
Returns Promise<void>

stop

stop(): Promise<void>

- Defined in ancient-tracker/src/lib/client.ts:36
Returns Promise<void>

stopping

stopping(): Promise<void>

- Defined in ancient-tracker/src/lib/client.ts:33
Returns Promise<void>

tracking

tracking(tracker: any): void

- Defined in ancient-tracker/src/lib/client.ts:38
Parameters
- tracker: any
Returns void

untracking

untracking(tracker: any): void

- Defined in ancient-tracker/src/lib/client.ts:39
Parameters
- tracker: any
Returns void

wrap

wrap(node: IN): this

Inherited from IManager.wrap
- Defined in ancient-cursor/node_modules/ancient-mixins/lib/manager.d.ts:15
Parameters
- node: IN
Returns this

Generated using TypeDoc