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.9/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

generateSignature

generateSignature(ref: string, env: string): Promise<AxiosResponse<any, any>>
Parameters
- ref: string
- env: string
Returns Promise<AxiosResponse<any, any>>
- Defined in v0.9/api/functions.ts:49

get

get(ref: string): Promise<any>
Parameters
- ref: string
Returns Promise<any>
- Defined in v0.9/api/functions.ts:9

list

list(): Promise<any>
Returns Promise<any>
- Defined in v0.9/api/functions.ts:5

run

run<K extends never>(
    id: K,
    d: {
        headers?: Record<string, string>;
        input?: FunctionInput<K>;
        query?: Record<string, string>;
    },
): Promise<FunctionOutput<K>>
Run a platform function.

When the function name is registered in PlatformFunctions, input and output types are inferred automatically from the IDL signature. Register signatures by running ptkl generate-types in your project.
Type Parameters
- K extends never
Parameters
- id: K
- d: {
      headers?: Record<string, string>;
      input?: FunctionInput<K>;
      query?: Record<string, string>;
  }
Returns Promise<FunctionOutput<K>>
Example
```
// Typed — "send_email" is registered in PlatformFunctions
const result = await fn.run("send_email", { input: { body: "hi", to: "a@b.com" } })
// result: { status: boolean }
```
Example
```
// Untyped fallback for unregistered names
const result = await fn.run("unknown_func", { input: { foo: "bar" } })
```
- Defined in v0.9/api/functions.ts:33
run(
    id: string,
    d: {
        headers?: Record<string, string>;
        input?: Record<string, any>;
        query?: Record<string, string>;
    },
): Promise<any>
Run a platform function.

When the function name is registered in PlatformFunctions, input and output types are inferred automatically from the IDL signature. Register signatures by running ptkl generate-types in your project.
Parameters
- id: string
- d: {
      headers?: Record<string, string>;
      input?: Record<string, any>;
      query?: Record<string, string>;
  }
Returns Promise<any>
Example
```
// Typed — "send_email" is registered in PlatformFunctions
const result = await fn.run("send_email", { input: { body: "hi", to: "a@b.com" } })
// result: { status: boolean }
```
Example
```
// Untyped fallback for unregistered names
const result = await fn.run("unknown_func", { input: { foo: "bar" } })
```
- Defined in v0.9/api/functions.ts:37

setClient

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

update

update(uuid: string, update: any): Promise<any>
Parameters
- uuid: string
- update: any
Returns Promise<any>
- Defined in v0.9/api/functions.ts:13

Class default

Param: client

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns default

Properties

client

Protectedenv

Protectedhost

Protectedtoken

Methods

generateSignature

Parameters

Returns Promise<AxiosResponse<any, any>>

get

Parameters

Returns Promise<any>

list

Returns Promise<any>

run

Type Parameters

Parameters

Returns Promise<FunctionOutput<K>>

Example

Example

Parameters

Returns Promise<any>

Example

Example

setClient

Parameters

Returns default

update

Parameters

Returns Promise<any>

Settings

On This Page

`Protected`env

`Protected`host

`Protected`token