Interface RESTOptions

interface RESTOptions {
    api: string;
    globalRequestsPerMinute: number;
    headers: undefined | HeadersInit;
    userAgent: IUserAgent;
    version: string;
}

Index

Properties

api globalRequestsPerMinute headers userAgent version

Properties

api

api: string

The base api path, without version

Default Value

'https://api.discloud.app'

globalRequestsPerMinute

globalRequestsPerMinute: number

How many requests to allow sending per second (Infinity for unlimited, 60 for the standard global limit used by Discloud)

Default Value

60

headers

headers: undefined | HeadersInit

Additional headers to send for all API requests

Default Value

{}

userAgent

userAgent: IUserAgent

version

version: string

The version of the API to use

Default Value

{APIVersion}