Class Component

Hierarchy

default
- Component

Index

Constructors

Properties

Methods

aggregate concurrentUpdate create delete find findOne function get modify saveSettings saveTemplatesDist setClient settings update updateMany workflow

Constructors

constructor

new Component(ref?: null | string): Component
Parameters
- ref: null | string = null
Returns Component
Overrides PlatformBaseClient.constructor
- Defined in api/component.ts:17

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

aggregate

aggregate(pipeline: FindAggregateParams): Promise<AxiosResponse<any, any>>
Parameters
- pipeline: FindAggregateParams
Returns Promise<AxiosResponse<any, any>>
- Defined in api/component.ts:232

concurrentUpdate

concurrentUpdate(
    uuid: string,
    version: number,
    data: Record<string, any>,
    options: UpdateOptions,
): Promise<AxiosResponse<any, any>>
Concurrent update model by uuid
Parameters
- uuid: string
  string - The uuid of the model
- version: number
  number - The version of the model
- data: Record<string, any>
- options: UpdateOptions
Returns Promise<AxiosResponse<any, any>>
- Defined in api/component.ts:216

create

create(model: Record<string, any>): Promise<AxiosResponse<any, any>>
Parameters
- model: Record<string, any>
Returns Promise<AxiosResponse<any, any>>
- Defined in api/component.ts:224

delete

delete(uuid: string): Promise<AxiosResponse<any, any>>
Parameters
- uuid: string
Returns Promise<AxiosResponse<any, any>>
- Defined in api/component.ts:228

find

find(
filters: FindParams,
opts?: FindOptions,
): Promise<AxiosResponse<FindResponse, any>>
Find method to search for models
Parameters
- filters: FindParams
  The filters to apply to the search
- Optionalopts: FindOptions
  The options to apply to the search
Returns Promise<AxiosResponse<FindResponse, any>>
- The result of the search
Example
```
platform.component(name).find({
    currentPage: 1,
    perPage: 10,
})

// advanced search
platform.component(name).find({
    $adv: {
        name: "John Doe",
    }
)
```
- Defined in api/component.ts:42

findOne

findOne(filter: FindAdvancedParams, opts: FindOptions): Promise<null | Model>
FindOne method to search for a single model
Parameters
- filter: FindAdvancedParams
  The filters to apply to the search
- opts: FindOptions
  The options to apply to the search
Returns Promise<null | Model>
- The result of the search
Example
```
platform.component(name).findOne({
    name: "John Doe",
})
```
- Defined in api/component.ts:141

function

function(name: string, input: any): Promise<AxiosResponse<any, any>>
Parameters
- name: string
- input: any
Returns Promise<AxiosResponse<any, any>>
- Defined in api/component.ts:261

get

get(uuid: string): Promise<AxiosResponse<Model, any>>
Get model by uuid
Parameters
- uuid: string
  string - The uuid of the model
Returns Promise<AxiosResponse<Model, any>>
(Promise)
- Defined in api/component.ts:161

modify

modify(
    filters: Record<string, any>,
    data: Record<string, any>,
    options: ModifyOptions,
): Promise<AxiosResponse<any, any>>
Modify models by filters
Parameters
- filters: Record<string, any>
- data: Record<string, any>
- options: ModifyOptions
Returns Promise<AxiosResponse<any, any>>
- Defined in api/component.ts:200

saveSettings

saveSettings(settings: any, version: string): Promise<AxiosResponse<any, any>>
Parameters
- settings: any
- version: string
Returns Promise<AxiosResponse<any, any>>
- Defined in api/component.ts:240

saveTemplatesDist

saveTemplatesDist(
    version: string,
    sdkVersion: string,
    engine: string,
    dist: Record<string, string>,
): Promise<any>
Parameters
- version: string
- sdkVersion: string
- engine: string
- dist: Record<string, string>
Returns Promise<any>
- Defined in api/component.ts:244

setClient

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

settings

settings(): Promise<AxiosResponse<any, any>>
Returns Promise<AxiosResponse<any, any>>
- Defined in api/component.ts:236

update

update(
    uuid: string,
    data: Record<string, any>,
    options: UpdateOptions,
): Promise<AxiosResponse<any, any>>
Update model by uuid
Parameters
- uuid: string
  string - The uuid of the model
- data: Record<string, any>
- options: UpdateOptions
Returns Promise<AxiosResponse<any, any>>
- Defined in api/component.ts:172

updateMany

updateMany(
data: Record<string, any>[],
options: UpdateOptions,
): Promise<AxiosResponse<any, any>>
Update many models
Parameters
- data: Record<string, any>[]
- options: UpdateOptions
Returns Promise<AxiosResponse<any, any>>
- Defined in api/component.ts:186

workflow

workflow(event: string, input: any): Promise<AxiosResponse<any, any>>
Parameters
- event: string
- input: any
Returns Promise<AxiosResponse<any, any>>
- Defined in api/component.ts:254

Class Component

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Component

Properties

client

Protectedenv

Protectedhost

Protectedtoken

Methods

aggregate

Parameters

Returns Promise<AxiosResponse<any, any>>

concurrentUpdate

Parameters

Returns Promise<AxiosResponse<any, any>>

create

Parameters

Returns Promise<AxiosResponse<any, any>>

delete

Parameters

Returns Promise<AxiosResponse<any, any>>

find

Parameters

Returns Promise<AxiosResponse<FindResponse, any>>

Example

findOne

Parameters

Returns Promise<null | Model>

Example

function

Parameters

Returns Promise<AxiosResponse<any, any>>

get

Parameters

Returns Promise<AxiosResponse<Model, any>>

modify

Parameters

Returns Promise<AxiosResponse<any, any>>

saveSettings

Parameters

Returns Promise<AxiosResponse<any, any>>

saveTemplatesDist

Parameters

Returns Promise<any>

setClient

Parameters

Returns Component

settings

Returns Promise<AxiosResponse<any, any>>

update

Parameters

Returns Promise<AxiosResponse<any, any>>

updateMany

Parameters

Returns Promise<AxiosResponse<any, any>>

workflow

Parameters

Returns Promise<AxiosResponse<any, any>>

Settings

On This Page

`Protected`env

`Protected`host

`Protected`token