Skip to main content

Wing Console - 0.1.43

Constructs ​

App ​

Initializers ​

import { core } from '@monadahq/wingsdk'

new core.App(props?: AppProps)
NameTypeDescription
props@monadahq/wingsdk.core.AppPropsNo description.
propsOptional ​
  • Type: @monadahq/wingsdk.core.AppProps

Methods ​

NameDescription
toStringReturns a string representation of this construct.
synthNo description.
toString ​
public toString(): string

Returns a string representation of this construct.

synth ​
public synth(): void

Static Functions ​

NameDescription
isConstructChecks if x is a construct.
isConstruct ​
import { core } from '@monadahq/wingsdk'

core.App.isConstruct(x: any)

Checks if x is a construct.

xRequired ​
  • Type: any

Any object.

Properties ​

NameTypeDescription
nodeconstructs.NodeThe tree node.
outdirstringNo description.
rootconstructs.ConstructNo description.
stateFilestringNo description.
nodeRequired ​
public readonly node: Node;
  • Type: constructs.Node

The tree node.

outdirRequired ​
public readonly outdir: string;
  • Type: string
rootRequired ​
public readonly root: Construct;
  • Type: constructs.Construct
stateFileOptional ​
public readonly stateFile: string;
  • Type: string

Bucket ​

  • Implements: @monadahq/wingsdk.core.ICapturable

Initializers ​

import { cloud } from '@monadahq/wingsdk'

new cloud.Bucket(scope: Construct, id: string)
NameTypeDescription
scopeconstructs.ConstructNo description.
idstringNo description.
scopeRequired ​
  • Type: constructs.Construct
idRequired ​
  • Type: string

Methods ​

NameDescription
toStringReturns a string representation of this construct.
captureNo description.
toString ​
public toString(): string

Returns a string representation of this construct.

capture ​
public capture(consumer: any, capture: Capture): string
consumerRequired ​
  • Type: any
captureRequired ​
  • Type: @monadahq/wingsdk.core.Capture

Static Functions ​

NameDescription
isConstructChecks if x is a construct.
isConstruct ​
import { cloud } from '@monadahq/wingsdk'

cloud.Bucket.isConstruct(x: any)

Checks if x is a construct.

xRequired ​
  • Type: any

Any object.

Properties ​

NameTypeDescription
nodeconstructs.NodeThe tree node.
nodeRequired ​
public readonly node: Node;
  • Type: constructs.Node

The tree node.

Endpoint ​

Initializers ​

import { cloud } from '@monadahq/wingsdk'

new cloud.Endpoint(scope: Construct, id: string)
NameTypeDescription
scopeconstructs.ConstructNo description.
idstringNo description.
scopeRequired ​
  • Type: constructs.Construct
idRequired ​
  • Type: string

Methods ​

NameDescription
toStringReturns a string representation of this construct.
onGetNo description.
toString ​
public toString(): string

Returns a string representation of this construct.

onGet ​
public onGet(route: string, proc: Process): void
routeRequired ​
  • Type: string
procRequired ​
  • Type: @monadahq/wingsdk.core.Process

Static Functions ​

NameDescription
isConstructChecks if x is a construct.
isConstruct ​
import { cloud } from '@monadahq/wingsdk'

cloud.Endpoint.isConstruct(x: any)

Checks if x is a construct.

xRequired ​
  • Type: any

Any object.

Properties ​

NameTypeDescription
nodeconstructs.NodeThe tree node.
nodeRequired ​
public readonly node: Node;
  • Type: constructs.Node

The tree node.

FileBase ​

Initializers ​

import { fs } from '@monadahq/wingsdk'

new fs.FileBase(scope: Construct, id: string, filePath: string)
NameTypeDescription
scopeconstructs.Constructconstruct scope.
idstringconstruct id.
filePathstringrelative file path.
scopeRequired ​
  • Type: constructs.Construct

construct scope.

idRequired ​
  • Type: string

construct id.

filePathRequired ​
  • Type: string

relative file path.

Methods ​

NameDescription
toStringReturns a string representation of this construct.
saveNo description.
toString ​
public toString(): string

Returns a string representation of this construct.

save ​
public save(outdir: string): void
outdirRequired ​
  • Type: string

Static Functions ​

NameDescription
isConstructChecks if x is a construct.
isConstruct ​
import { fs } from '@monadahq/wingsdk'

fs.FileBase.isConstruct(x: any)

Checks if x is a construct.

xRequired ​
  • Type: any

Any object.

Properties ​

NameTypeDescription
nodeconstructs.NodeThe tree node.
filePathstringNo description.
nodeRequired ​
public readonly node: Node;
  • Type: constructs.Node

The tree node.

filePathRequired ​
public readonly filePath: string;
  • Type: string

Function ​

Initializers ​

import { cloud } from '@monadahq/wingsdk'

new cloud.Function(scope: Construct, id: string, process: Process)
NameTypeDescription
scopeconstructs.ConstructNo description.
idstringNo description.
process@monadahq/wingsdk.core.ProcessNo description.
scopeRequired ​
  • Type: constructs.Construct
idRequired ​
  • Type: string
processRequired ​
  • Type: @monadahq/wingsdk.core.Process

Methods ​

NameDescription
toStringReturns a string representation of this construct.
addEnvironmentNo description.
addPolicyStatementsNo description.
toString ​
public toString(): string

Returns a string representation of this construct.

addEnvironment ​
public addEnvironment(name: string, value: string): void
nameRequired ​
  • Type: string
valueRequired ​
  • Type: string
addPolicyStatements ​
public addPolicyStatements(statements: PolicyStatement): void
statementsRequired ​
  • Type: @monadahq/wingsdk.cloud.PolicyStatement

Static Functions ​

NameDescription
isConstructChecks if x is a construct.
isConstruct ​
import { cloud } from '@monadahq/wingsdk'

cloud.Function.isConstruct(x: any)

Checks if x is a construct.

xRequired ​
  • Type: any

Any object.

Properties ​

NameTypeDescription
nodeconstructs.NodeThe tree node.
nodeRequired ​
public readonly node: Node;
  • Type: constructs.Node

The tree node.

JsonFile ​

Initializers ​

import { fs } from '@monadahq/wingsdk'

new fs.JsonFile(scope: Construct, id: string, filePath: string, props: JsonFileProps)
NameTypeDescription
scopeconstructs.ConstructNo description.
idstringNo description.
filePathstringNo description.
props@monadahq/wingsdk.fs.JsonFilePropsNo description.
scopeRequired ​
  • Type: constructs.Construct
idRequired ​
  • Type: string
filePathRequired ​
  • Type: string
propsRequired ​
  • Type: @monadahq/wingsdk.fs.JsonFileProps

Methods ​

NameDescription
toStringReturns a string representation of this construct.
saveNo description.
toString ​
public toString(): string

Returns a string representation of this construct.

save ​
public save(outdir: string): void
outdirRequired ​
  • Type: string

Static Functions ​

NameDescription
isConstructChecks if x is a construct.
isConstruct ​
import { fs } from '@monadahq/wingsdk'

fs.JsonFile.isConstruct(x: any)

Checks if x is a construct.

xRequired ​
  • Type: any

Any object.

Properties ​

NameTypeDescription
nodeconstructs.NodeThe tree node.
filePathstringNo description.
nodeRequired ​
public readonly node: Node;
  • Type: constructs.Node

The tree node.

filePathRequired ​
public readonly filePath: string;
  • Type: string

Queue ​

Initializers ​

import { cloud } from '@monadahq/wingsdk'

new cloud.Queue(scope: Construct, id: string, props?: QueueProps)
NameTypeDescription
scopeconstructs.ConstructNo description.
idstringNo description.
props@monadahq/wingsdk.cloud.QueuePropsNo description.
scopeRequired ​
  • Type: constructs.Construct
idRequired ​
  • Type: string
propsOptional ​
  • Type: @monadahq/wingsdk.cloud.QueueProps

Methods ​

NameDescription
toStringReturns a string representation of this construct.
addWorkerNo description.
helloNo description.
toString ​
public toString(): string

Returns a string representation of this construct.

addWorker ​
public addWorker(fn: Function): void
fnRequired ​
  • Type: @monadahq/wingsdk.cloud.Function
hello ​
public hello(): void

Static Functions ​

NameDescription
isConstructChecks if x is a construct.
isConstruct ​
import { cloud } from '@monadahq/wingsdk'

cloud.Queue.isConstruct(x: any)

Checks if x is a construct.

xRequired ​
  • Type: any

Any object.

Properties ​

NameTypeDescription
nodeconstructs.NodeThe tree node.
nodeRequired ​
public readonly node: Node;
  • Type: constructs.Node

The tree node.

TextFile ​

Initializers ​

import { fs } from '@monadahq/wingsdk'

new fs.TextFile(scope: Construct, id: string, filePath: string, props?: TextFileProps)
NameTypeDescription
scopeconstructs.ConstructNo description.
idstringNo description.
filePathstringNo description.
props@monadahq/wingsdk.fs.TextFilePropsNo description.
scopeRequired ​
  • Type: constructs.Construct
idRequired ​
  • Type: string
filePathRequired ​
  • Type: string
propsOptional ​
  • Type: @monadahq/wingsdk.fs.TextFileProps

Methods ​

NameDescription
toStringReturns a string representation of this construct.
saveNo description.
addLineNo description.
toString ​
public toString(): string

Returns a string representation of this construct.

save ​
public save(outdir: string): void
outdirRequired ​
  • Type: string
addLine ​
public addLine(line: string): void
lineRequired ​
  • Type: string

Static Functions ​

NameDescription
isConstructChecks if x is a construct.
isConstruct ​
import { fs } from '@monadahq/wingsdk'

fs.TextFile.isConstruct(x: any)

Checks if x is a construct.

xRequired ​
  • Type: any

Any object.

Properties ​

NameTypeDescription
nodeconstructs.NodeThe tree node.
filePathstringNo description.
nodeRequired ​
public readonly node: Node;
  • Type: constructs.Node

The tree node.

filePathRequired ​
public readonly filePath: string;
  • Type: string

Structs ​

AppProps ​

Initializer ​

import { core } from '@monadahq/wingsdk'

const appProps: core.AppProps = { ... }

Properties ​

NameTypeDescription
outdirstringThe root output directory of the app.
stateFilestringThe path to a state file which will track all synthesized files.
outdirOptional ​
public readonly outdir: string;
  • Type: string
  • Default: "."

The root output directory of the app.

stateFileOptional ​
public readonly stateFile: string;
  • Type: string

The path to a state file which will track all synthesized files.

If a statefile is not specified, we won't be able to remove extrenous files.

Capture ​

Initializer ​

import { core } from '@monadahq/wingsdk'

const capture: core.Capture = { ... }

Properties ​

NameTypeDescription
objanyThe captured object.
methodsstring[]Which methods are called on the captured object.
objRequired ​
public readonly obj: any;
  • Type: any

The captured object.

methodsOptional ​
public readonly methods: string[];
  • Type: string[]

Which methods are called on the captured object.

JsonFileProps ​

Initializer ​

import { fs } from '@monadahq/wingsdk'

const jsonFileProps: fs.JsonFileProps = { ... }

Properties ​

NameTypeDescription
objanyThe object that will be serialized into the file during synthesis.
objRequired ​
public readonly obj: any;
  • Type: any

The object that will be serialized into the file during synthesis.

PolicyStatement ​

Initializer ​

import { cloud } from '@monadahq/wingsdk'

const policyStatement: cloud.PolicyStatement = { ... }

Properties ​

NameTypeDescription
actionstring[]No description.
effectstringNo description.
resourcestring[]No description.
actionOptional ​
public readonly action: string[];
  • Type: string[]
effectOptional ​
public readonly effect: string;
  • Type: string
resourceOptional ​
public readonly resource: string[];
  • Type: string[]

ProcessProps ​

Initializer ​

import { core } from '@monadahq/wingsdk'

const processProps: core.ProcessProps = { ... }

Properties ​

NameTypeDescription
pathstringNo description.
captures{[ key: string ]: @monadahq/wingsdk.core.Capture}No description.
pathRequired ​
public readonly path: string;
  • Type: string
capturesOptional ​
public readonly captures: {[ key: string ]: Capture};
  • Type: {[ key: string ]: @monadahq/wingsdk.core.Capture}

QueueProps ​

Initializer ​

import { cloud } from '@monadahq/wingsdk'

const queueProps: cloud.QueueProps = { ... }

Properties ​

NameTypeDescription
timeout@monadahq/wingsdk.core.DurationNo description.
timeoutOptional ​
public readonly timeout: Duration;
  • Type: @monadahq/wingsdk.core.Duration

TextFileProps ​

Initializer ​

import { fs } from '@monadahq/wingsdk'

const textFileProps: fs.TextFileProps = { ... }

Properties ​

NameTypeDescription
linesstring[]No description.
linesOptional ​
public readonly lines: string[];
  • Type: string[]

Classes ​

Duration ​

Static Functions ​

NameDescription
fromHoursNo description.
fromMinutesNo description.
fromSecondsNo description.
fromHours ​
import { core } from '@monadahq/wingsdk'

core.Duration.fromHours(amount: number)
amountRequired ​
  • Type: number
fromMinutes ​
import { core } from '@monadahq/wingsdk'

core.Duration.fromMinutes(amount: number)
amountRequired ​
  • Type: number
fromSeconds ​
import { core } from '@monadahq/wingsdk'

core.Duration.fromSeconds(amount: number)
amountRequired ​
  • Type: number

Properties ​

NameTypeDescription
hoursnumberNo description.
minutesnumberNo description.
secondsnumberNo description.
hoursRequired ​
public readonly hours: number;
  • Type: number
minutesRequired ​
public readonly minutes: number;
  • Type: number
secondsRequired ​
public readonly seconds: number;
  • Type: number

Process ​

Initializers ​

import { core } from '@monadahq/wingsdk'

new core.Process(props: ProcessProps)
NameTypeDescription
props@monadahq/wingsdk.core.ProcessPropsNo description.
propsRequired ​
  • Type: @monadahq/wingsdk.core.ProcessProps

Properties ​

NameTypeDescription
captures{[ key: string ]: @monadahq/wingsdk.core.Capture}No description.
pathstringNo description.
capturesRequired ​
public readonly captures: {[ key: string ]: Capture};
  • Type: {[ key: string ]: @monadahq/wingsdk.core.Capture}
pathRequired ​
public readonly path: string;
  • Type: string

Protocols ​

ICapturable ​

  • Implemented By: @monadahq/wingsdk.cloud.Bucket, @monadahq/wingsdk.core.ICapturable

Methods ​

NameDescription
captureNo description.
capture ​
public capture(consumer: any, capture: Capture): string
consumerRequired ​
  • Type: any
captureRequired ​
  • Type: @monadahq/wingsdk.core.Capture