@reactor/functions — functionsclient
@reactor/functions / FunctionsClient
Class: FunctionsClient
Section titled “Class: FunctionsClient”Defined in: index.ts:36
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FunctionsClient(
ctx):FunctionsClient
Defined in: index.ts:37
Parameters
Section titled “Parameters”RequestContext
Returns
Section titled “Returns”FunctionsClient
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get env():
object
Defined in: index.ts:146
Admin: Environment variables
Returns
Section titled “Returns”object
list: (
name) =>Promise<Result<EnvVar[]>>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<EnvVar[]>>
set: (
name,vars) =>Promise<Result<void>>
Parameters
Section titled “Parameters”string
Record<string, string>
Returns
Section titled “Returns”Promise<Result<void>>
unset: (
name,keys) =>Promise<Result<void>>
Parameters
Section titled “Parameters”string
string[]
Returns
Section titled “Returns”Promise<Result<void>>
Get Signature
Section titled “Get Signature”get logs():
object
Defined in: index.ts:160
Admin: Logs
Returns
Section titled “Returns”object
list: (
name,options?) =>Promise<Result<FunctionLog[]>>
Parameters
Section titled “Parameters”string
options?
Section titled “options?”limit?
Section titled “limit?”number
since?
Section titled “since?”string
Returns
Section titled “Returns”Promise<Result<FunctionLog[]>>
versions
Section titled “versions”Get Signature
Section titled “Get Signature”get versions():
object
Defined in: index.ts:172
Admin: Versions
Returns
Section titled “Returns”object
list: (
name) =>Promise<Result<FunctionVersion[]>>
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<Result<FunctionVersion[]>>
rollback
Section titled “rollback”rollback: (
name,version) =>Promise<Result<void>>
Parameters
Section titled “Parameters”string
version
Section titled “version”string
Returns
Section titled “Returns”Promise<Result<void>>
Methods
Section titled “Methods”deploy()
Section titled “deploy()”deploy(
name,bundle,options?):Promise<Result<{version:string; }>>
Defined in: index.ts:130
Admin: Deploy a function
Parameters
Section titled “Parameters”string
bundle
Section titled “bundle”Blob | ArrayBuffer
options?
Section titled “options?”version?
Section titled “version?”string
Returns
Section titled “Returns”Promise<Result<{ version: string; }>>
invoke()
Section titled “invoke()”invoke<
T>(name,options?):Promise<Result<T>>
Defined in: index.ts:42
Invoke a function and return JSON response.
Type Parameters
Section titled “Type Parameters”T = unknown
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Result<T>>
invokeRaw()
Section titled “invokeRaw()”invokeRaw(
name,options?):Promise<Response>
Defined in: index.ts:103
Invoke a function and return raw Response.
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”Promise<Response>
invokeStream()
Section titled “invokeStream()”invokeStream(
name,options?):AsyncIterable<string>
Defined in: index.ts:58
Invoke a function and stream the response (SSE).
Parameters
Section titled “Parameters”string
options?
Section titled “options?”Returns
Section titled “Returns”AsyncIterable<string>