Class StatsApi

Hierarchy (View Summary)

ApiGroup
- StatsApi

Index

Constructors

Properties

client eip712 listeners

Methods

attributionHeaders emit leaderboard off on once removeAllListeners resolveWorkloadAttribution

Constructors

constructor

new StatsApi(config: ApiConfig): StatsApi
Parameters
- config: ApiConfig
Returns StatsApi
Inherited from ApiGroup.constructor
- Defined in ApiGroup.ts:16

Properties

`Protected`client

client: ApiClient

`Protected`eip712

eip712: EIP712Helper

`Protected`listeners

listeners: {} = {}

Methods

`Protected`attributionHeaders

attributionHeaders(
    appSource: undefined | string,
    override?: WorkloadAttributionInput,
    fallbackOperationId?: string,
): Record<string, string>
Parameters
- appSource: undefined | string
- Optionaloverride: WorkloadAttributionInput
- OptionalfallbackOperationId: string
Returns Record<string, string>
Inherited from ApiGroup.attributionHeaders
- Defined in ApiGroup.ts:33

`Protected`emit

emit<T extends never>(event: T, data: {}[T]): void
Dispatch an event to all listeners
Type Parameters
- T extends never
Parameters
- event: T
- data: {}[T]
Returns void
Inherited from ApiGroup.emit
- Defined in lib/TypedEventEmitter.ts:69

leaderboard

leaderboard(params: LeaderboardParams): Promise<LeaderboardItem[]>
Parameters
- params: LeaderboardParams
Returns Promise<LeaderboardItem[]>
- Defined in Stats/index.ts:6

off

off<T extends never>(event: T, listener: (data: {}[T]) => void): void
Remove an event listener
Type Parameters
- T extends never
Parameters
- event: T
- listener: (data: {}[T]) => void
Returns void
Inherited from ApiGroup.off
- Defined in lib/TypedEventEmitter.ts:45

on

on<T extends never>(event: T, listener: (data: {}[T]) => void): () => void
Add an event listener, returns a function that can be called to remove the listener
Type Parameters
- T extends never
Parameters
- event: T
- listener: (data: {}[T]) => void
Returns () => void
Inherited from ApiGroup.on
- Defined in lib/TypedEventEmitter.ts:17

once

once<T extends never>(event: T, listener: (data: {}[T]) => void): () => void
Add an event listener that will be called only once
Type Parameters
- T extends never
Parameters
- event: T
- listener: (data: {}[T]) => void
Returns () => void
Inherited from ApiGroup.once
- Defined in lib/TypedEventEmitter.ts:32

removeAllListeners

removeAllListeners<T extends never>(event?: T): void
Remove all event listeners, optionally for a specific event
Type Parameters
- T extends never
Parameters
- Optionalevent: T
Returns void
Inherited from ApiGroup.removeAllListeners
- Defined in lib/TypedEventEmitter.ts:56

`Protected`resolveWorkloadAttribution

resolveWorkloadAttribution(
override?: WorkloadAttributionInput,
fallbackOperationId?: string,
): undefined | WorkloadAttributionInput
Parameters
- Optionaloverride: WorkloadAttributionInput
- OptionalfallbackOperationId: string
Returns undefined | WorkloadAttributionInput
Inherited from ApiGroup.resolveWorkloadAttribution
- Defined in ApiGroup.ts:22