Class SDKFunctions

Class providing methods for working with SDK App Functions

Index

Constructors

Methods

create delete get getCode getTest list setCode setTest

Constructors

constructor

new SDKFunctions(fetch: FetchFunction): SDKFunctions
Parameters
- fetch: FetchFunction
Returns SDKFunctions
- Defined in src/endpoints/sdk/functions.ts:55

Methods

create

create(
    appName: string,
    appVersion: number,
    body: CreateSDKFunctionBody,
): Promise<Pick<SDKFunction, "name">>
Create a new function
Parameters
- appName: string
- appVersion: number
- body: CreateSDKFunctionBody
Returns Promise<Pick<SDKFunction, "name">>
- Defined in src/endpoints/sdk/functions.ts:80

delete

delete(appName: string, appVersion: number, functionName: string): Promise<void>
Delete a function
Parameters
- appName: string
- appVersion: number
- functionName: string
Returns Promise<void>
- Defined in src/endpoints/sdk/functions.ts:91

get

get(
    appName: string,
    appVersion: number,
    functionName: string,
): Promise<Pick<SDKFunction, "name">>
Get a single function by name
Parameters
- appName: string
- appVersion: number
- functionName: string
Returns Promise<Pick<SDKFunction, "name">>
- Defined in src/endpoints/sdk/functions.ts:70

getCode

getCode(
    appName: string,
    appVersion: number,
    functionName: string,
): Promise<string>
Get function code
Parameters
- appName: string
- appVersion: number
- functionName: string
Returns Promise<string>
- Defined in src/endpoints/sdk/functions.ts:100

getTest

getTest(
    appName: string,
    appVersion: number,
    functionName: string,
): Promise<string>
Get function test code
Parameters
- appName: string
- appVersion: number
- functionName: string
Returns Promise<string>
- Defined in src/endpoints/sdk/functions.ts:128

list

list(appName: string, appVersion: number): Promise<SDKFunction[]>
List functions for the app
Parameters
- appName: string
- appVersion: number
Returns Promise<SDKFunction[]>
- Defined in src/endpoints/sdk/functions.ts:62

setCode

setCode(
    appName: string,
    appVersion: number,
    functionName: string,
    code: string,
): Promise<void>
Set/update function code
Parameters
- appName: string
- appVersion: number
- functionName: string
- code: string
Returns Promise<void>
- Defined in src/endpoints/sdk/functions.ts:115

setTest

setTest(
    appName: string,
    appVersion: number,
    functionName: string,
    test: string,
): Promise<boolean>
Set/update function test code
Parameters
- appName: string
- appVersion: number
- functionName: string
- test: string
Returns Promise<boolean>
- Defined in src/endpoints/sdk/functions.ts:143