Class default

Base client for the platform API Classes that extend PlatformBaseClient have intentins of only working in platform context

PlatformBaseClient

Param: client

The axios instance to use for the client

Example

// if sdk is used in the forge app that is running in the platform context
const utils = new ComponentUtils()
// this won't work outside of platform context because client needs authtorization to communicate with the API.

Hierarchy (View Summary)

default
- default

Index

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/platformBaseClient.ts:24

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

delete

delete(name: string, filters: any): Promise<AxiosResponse<any, any>>
Parameters
- name: string
- filters: any
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/thunder.ts:53

find

find(
    name: string,
    filters: any,
    options?: ThunderReadOptions,
): Promise<AxiosResponse<any, any>>
Parameters
- name: string
- filters: any
- Optionaloptions: ThunderReadOptions
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/thunder.ts:29

findOne

findOne(
    name: string,
    filters: any,
    options?: ThunderReadOptions,
): Promise<AxiosResponse<any, any>>
Parameters
- name: string
- filters: any
- Optionaloptions: ThunderReadOptions
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/thunder.ts:33

insertOne

insertOne(name: string, data: any): Promise<AxiosResponse<any, any>>
Parameters
- name: string
- data: any
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/thunder.ts:45

operation

operation(
    name: string,
    filters: any,
    data: any,
): Promise<AxiosResponse<any, any>>
Parameters
- name: string
- filters: any
- data: any
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/thunder.ts:25

paginate

paginate(
    name: string,
    filters: any,
    options?: ThunderReadOptions,
): Promise<AxiosResponse<any, any>>
Parameters
- name: string
- filters: any
- Optionaloptions: ThunderReadOptions
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/thunder.ts:37

read

read(
    type: string,
    filters: any,
    flag: string,
    opts?: ThunderReadOptions,
): Promise<AxiosResponse<any, any>>
Parameters
- type: string
- filters: any
- flag: string
- Optionalopts: ThunderReadOptions
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/thunder.ts:5

setClient

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

updateOne

updateOne(
    name: string,
    filters: any,
    data: any,
): Promise<AxiosResponse<any, any>>
Parameters
- name: string
- filters: any
- data: any
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/thunder.ts:49

upsert

upsert(name: string, filters: any, data: any): Promise<AxiosResponse<any, any>>
Parameters
- name: string
- filters: any
- data: any
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/thunder.ts:41

write

write(
    type: string,
    filters: any,
    d: any,
    flag: any,
): Promise<AxiosResponse<any, any>>
Parameters
- type: string
- filters: any
- d: any
- flag: any
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.10/api/thunder.ts:16

Class default

Param: client

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

client

Protectedenv

Protectedhost

Protectedtoken

Methods

delete

Parameters

Returns Promise<AxiosResponse<any, any>>

find

Parameters

Returns Promise<AxiosResponse<any, any>>

findOne

Parameters

Returns Promise<AxiosResponse<any, any>>

insertOne

Parameters

Returns Promise<AxiosResponse<any, any>>

operation

Parameters

Returns Promise<AxiosResponse<any, any>>

paginate

Parameters

Returns Promise<AxiosResponse<any, any>>

read

Parameters

Returns Promise<AxiosResponse<any, any>>

setClient

Parameters

Returns default

updateOne

Parameters

Returns Promise<AxiosResponse<any, any>>

upsert

Parameters

Returns Promise<AxiosResponse<any, any>>

write

Parameters

Returns Promise<AxiosResponse<any, any>>

Settings

On This Page

`Protected`env

`Protected`host

`Protected`token