API.md

API Reference

Classes

Name	Description
CFunction	No description

Structs

Name	Description
CFunctionProps	No description
ExecOptions	No description

class CFunction

Initializer

new CFunction(props: CFunctionProps)

• props (CFunctionProps) No description
  • capture (Map<string, any>) Symbols to capture. Optional
  • code (string) Javascript code to execute. Default: "true;"

Properties

Name	Type	Description
env	Map<string, string>	Environment variables that are expected to be available when the function is executed.
outfile	string	The location of the function bundle (.js file).

Methods

toJson()

toJson(): any

Returns:

• any

static exec(file, options?)

static exec(file: string, options?: ExecOptions): any

• file (string) No description
• options (ExecOptions) No description
  • env (Map<string, string>) Environment variables to bind to the child process. Default: {}

Returns:

• any

struct CFunctionProps

Name	Type	Description
capture?	Map<string, any>	Symbols to capture. Optional
code?	string	Javascript code to execute. Default: "true;"

struct ExecOptions

Name	Type	Description
env?	Map<string, string>	Environment variables to bind to the child process. Default: {}