Class Sandbox

Hierarchy

default
- Sandbox

Index

Constructors

Properties

client env host token

Methods

setClient spark

Constructors

constructor

new Sandbox(options?: { env?: string; host?: string; token?: string }): Sandbox
Parameters
- Optionaloptions: { env?: string; host?: string; token?: string }
Returns Sandbox
Inherited from PlatformBaseClient.constructor
- Defined in api/platformBaseClient.ts:25

Properties

client

client: AxiosInstance

`Protected`env

env: null | string = null

`Protected`host

host: null | string = null

`Protected`token

token: null | string = null

Methods

setClient

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

spark

spark(name: string, data: any): Promise<AxiosResponse<any, any>>
Call the sandbox service to execute a serverless function
Parameters
- name: string
- data: any
Returns Promise<AxiosResponse<any, any>>
Example
```
const result = await platform.sandbox().spark("myFunction", { foo: "bar" })
```
- Defined in api/sandbox.ts:14