See:

https://github.com/axios/axios

View Source admin-bro/src/frontend/utils/api-client.ts, line 55

Methods

# async bulkAction(options) → {Promise.<BulkActionResponse>}

Invokes given bulk Action on the backend.

Parameters:

Name	Type	Description
`options`	BulkActionAPIParams

View Source admin-bro/src/frontend/utils/api-client.ts, line 130

Returns:

response from an Action

Type: Promise.<BulkActionResponse>

# async getDashboard(options) → {Promise.<AxiosResponse.<any>>}

Invokes dashboard handler.

Parameters:

Name	Type	Description
`options`	AxiosRequestConfig

View Source admin-bro/src/frontend/utils/api-client.ts, line 151

Returns:

response from the handler function defined in AdminBroOptions#dashboard

Type: Promise.<AxiosResponse.<any>>

# async getPage(options) → {Promise.<AxiosResponse.<any>>}

Invokes handler function of given page and returns its response.

Parameters:

Name	Type	Description
`options`	GetPageAPIParams

View Source admin-bro/src/frontend/utils/api-client.ts, line 163

Returns:

response from the handler of given page defined in AdminBroOptions#pages

Type: Promise.<AxiosResponse.<any>>

# async recordAction(options) → {Promise.<RecordActionResponse>}

Invokes given record Action on the backend.

Parameters:

Name	Type	Description
`options`	RecordActionAPIParams

View Source admin-bro/src/frontend/utils/api-client.ts, line 113

Returns:

response from an Action

Type: Promise.<RecordActionResponse>

# async resourceAction(options) → {Promise.<ActionResponse>}

Invokes given resource Action on the backend.

Parameters:

Name	Type	Description
`options`	ResourceActionAPIParams

View Source admin-bro/src/frontend/utils/api-client.ts, line 91

Returns:

response from an Action

Type: Promise.<ActionResponse>

# async searchRecords(options) → {Promise.<SearchResponse>}

Search by query string for records in a given resource.

Parameters:

Name	Type	Description
`options`	Object
`resourceId`	String	id of a ResourceJSON
`query`	String	query string

View Source admin-bro/src/frontend/utils/api-client.ts, line 76

Returns:

Type: Promise.<SearchResponse>

Type Definitions

Type: object

# ActionAPIParams

Extends AxiosRequestConfig

Properties:

Name	Type	Description
`...`	any	any property supported by AxiosRequestConfig

View Source admin-bro/src/frontend/utils/api-client.ts, line 182

Type: object

# AxiosRequestConfig

Type of an axios request

See:

https://github.com/axios/axios/blob/master/index.d.ts#L43

View Source admin-bro/src/frontend/utils/api-client.ts, line 15

Type: object

# BulkActionAPIParams

Extends ActionAPIParams

Properties:

Name	Type	Description
`...`	any	any property supported by ActionAPIParams

See:

https://github.com/axios/axios/blob/master/index.d.ts#L43

View Source admin-bro/src/frontend/utils/api-client.ts, line 207

Type: object

# GetPageAPIParams

Extends AxiosRequestConfig

Properties:

Name	Type	Description
`...`	any	any property supported by AxiosRequestConfig
`pageName`	string	Unique page name

View Source admin-bro/src/frontend/utils/api-client.ts, line 216

Type: object

# RecordActionAPIParams

Extends ActionAPIParams

Properties:

Name	Type	Description
`...`	any	any property supported by ActionAPIParams

View Source admin-bro/src/frontend/utils/api-client.ts, line 199

Type: object

# ResourceActionAPIParams

Extends ActionAPIParams

Properties:

Name	Type	Attributes	Description
`...`	any		any property supported by AxiosRequestConfig
`query`	string	<optional>

View Source admin-bro/src/frontend/utils/api-client.ts, line 190

ApiClient

ApiClient

Methods

# async bulkAction(options) → {Promise.<BulkActionResponse>}

Parameters:

# async getDashboard(options) → {Promise.<AxiosResponse.<any>>}

Parameters:

# async getPage(options) → {Promise.<AxiosResponse.<any>>}

Parameters:

# async recordAction(options) → {Promise.<RecordActionResponse>}

Parameters:

# async resourceAction(options) → {Promise.<ActionResponse>}

Parameters:

# async searchRecords(options) → {Promise.<SearchResponse>}

Parameters:

Type Definitions

# ActionAPIParams

Properties:

# AxiosRequestConfig

# BulkActionAPIParams

Properties:

# GetPageAPIParams

Properties:

# RecordActionAPIParams

Properties:

# ResourceActionAPIParams

Properties:

Software House with a passion for both JavaScript and TypeScript.