Class default

Hierarchy (View Summary)

default
- default

Index

Constructors

Properties

client env host token

Methods

debug error info query setClient usage warn write

Constructors

constructor

new default(options?: { env?: string; host?: string; token?: string }): default
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns default
Inherited from default.constructor
- Defined in v0.10/api/integrationsBaseClient.ts:10

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

debug

debug(
message: string,
payload?: TimberLogPayload,
): Promise<{ accepted: boolean }>
Parameters
- message: string
- Optionalpayload: TimberLogPayload
Returns Promise<{ accepted: boolean }>
- Defined in v0.10/api/integrations/timber.ts:28

error

error(
message: string,
payload?: TimberLogPayload,
): Promise<{ accepted: boolean }>
Parameters
- message: string
- Optionalpayload: TimberLogPayload
Returns Promise<{ accepted: boolean }>
- Defined in v0.10/api/integrations/timber.ts:40

info

info(
message: string,
payload?: TimberLogPayload,
): Promise<{ accepted: boolean }>
Parameters
- message: string
- Optionalpayload: TimberLogPayload
Returns Promise<{ accepted: boolean }>
- Defined in v0.10/api/integrations/timber.ts:32

query

query(params?: TimberQueryParams): Promise<TimberQueryResponse>
Parameters
- params: TimberQueryParams = {}
Returns Promise<TimberQueryResponse>
- Defined in v0.10/api/integrations/timber.ts:11

setClient

setClient(client: AxiosInstance): default
Parameters
- client: AxiosInstance
Returns default
Inherited from default.setClient
- Defined in v0.10/api/baseClient.ts:10

usage

usage(): Promise<TimberUsage>
Returns Promise<TimberUsage>
- Defined in v0.10/api/integrations/timber.ts:23

warn

warn(
message: string,
payload?: TimberLogPayload,
): Promise<{ accepted: boolean }>
Parameters
- message: string
- Optionalpayload: TimberLogPayload
Returns Promise<{ accepted: boolean }>
- Defined in v0.10/api/integrations/timber.ts:36

write

write(payload: TimberWritePayload): Promise<{ accepted: boolean }>
Parameters
- payload: TimberWritePayload
Returns Promise<{ accepted: boolean }>
- Defined in v0.10/api/integrations/timber.ts:18