Interface BaseRequest

interface BaseRequest {
    api_version?: number;
    command: string;
    id?: string | number;
    [x: string]: unknown;
}

Hierarchy (View Summary)

Indexable

  • [x: string]: unknown

Properties

api_version? command id?

Properties

Optionalapi_version

api_version?: number

The API version to use. If omitted, use version 1.

command

command: string

The name of the API method.

Optionalid

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Settings

Member Visibility

On This Page

Properties