Module "apis/statistics"

Index

Interfaces

Type aliases

Functions

Type aliases

StatisticProviderDetector

StatisticProviderDetector: (name: string, context: StatisticApiContext) => StatisticProviderDetectorResult | PromiseLike<StatisticProviderDetectorResult>

A function that detects a statistic provider by name.

param: The name of the provider, in lower case letters.
param: The context.
returns: The result.

Type declaration

- (name: string, context: StatisticApiContext): StatisticProviderDetectorResult | PromiseLike<StatisticProviderDetectorResult>
- Parameters
  - name: string
  - context: StatisticApiContext
  Returns StatisticProviderDetectorResult | PromiseLike<StatisticProviderDetectorResult>

StatisticProviderDetectorResult

StatisticProviderDetectorResult: StatisticProvider | false

The result of a statistic provider detection function.

Functions

registerStatisticsEndpoint

registerStatisticsEndpoint(hostOrRouter: express.Express | express.Router, opts: RegisterStatisticsEndpointOptions): void

- Defined in src/apis/statistics.ts:134
Registers an API endpoint for providing statistics.

Parameters
- hostOrRouter: express.Express | express.Router
  
  The host or router.
- opts: RegisterStatisticsEndpointOptions
  
  The options for the registration.
Returns void

toStatisticParameters

toStatisticParameters(query: any): StatisticParameters

- Defined in src/apis/statistics.ts:254
Parameters
- query: any
Returns StatisticParameters

Generated using TypeDoc