Class LowLevelApi

Hierarchy (View Summary)

EventEmitter<ApiEventMap>
- LowLevelApi

Implements

PitcherAPI

Index

Constructors

Properties

callbacks listeners

Methods

emit off on request

Constructors

constructor

new LowLevelApi(options?: ApiOptions): LowLevelApi
Parameters
- Optionaloptions: ApiOptions
Returns LowLevelApi
Overrides EventEmitter.constructor
- Defined in src/lib/sdk/api/LowLevelApi.ts:20

Properties

callbacks

callbacks: {
    [k: string]: {
        callback: (res: PitcherResponse) => void;
        dispatched_at: number;
        payload: object;
        type: string;
    };
}

listeners

listeners: { [key: string]: undefined | (p: any) => void[] } = {}

Methods

emit

emit<Key extends "event">(eventName: Key, data?: ApiEventMap[Key]): void
Type Parameters
- Key extends "event"
Parameters
- eventName: Key
- Optionaldata: ApiEventMap[Key]
Returns void
Implementation of PitcherAPI.emit
Inherited from EventEmitter.emit
- Defined in src/lib/sdk/utils/eventEmitter.ts:22

off

off<Key extends "event">(
eventName: Key,
fn: EventReceiver<ApiEventMap[Key]>,
): void
Type Parameters
- Key extends "event"
Parameters
- eventName: Key
- fn: EventReceiver<ApiEventMap[Key]>
Returns void
Implementation of PitcherAPI.off
Inherited from EventEmitter.off
- Defined in src/lib/sdk/utils/eventEmitter.ts:19

on

on<Key extends "event">(
eventName: Key,
fn: EventReceiver<ApiEventMap[Key]>,
): void
Type Parameters
- Key extends "event"
Parameters
- eventName: Key
- fn: EventReceiver<ApiEventMap[Key]>
Returns void
Implementation of PitcherAPI.on
Inherited from EventEmitter.on
- Defined in src/lib/sdk/utils/eventEmitter.ts:16

request

request(type: string, body?: null | object): Promise<any>
Parameters
- type: string
- body: null | object = null
Returns Promise<any>
Implementation of PitcherAPI.request
- Defined in src/lib/sdk/api/LowLevelApi.ts:71