Skip to main content

Class: E2eTestFunction

Defined in: packages/depot-cdk/src/stage-depot-e2e-test.ts:193

Creates a Depot E2E Test StepFunction State Machine

Extends​

  • Construct

Constructors​

Constructor​

new E2eTestFunction(scope, id, props): E2eTestFunction

Defined in: packages/depot-cdk/src/stage-depot-e2e-test.ts:202

Create a Depot E2E Testing Step Function.

Parameters​

scope​

Construct

The CDK Construct scope to add the resource to

id​

string

unique ID for this resource.

props​

E2eTestFunctionProps

properties to configure the E2E Step Function.

Returns​

E2eTestFunction

Overrides​

Construct.constructor

Properties​

node​

readonly node: Node

Defined in: node_modules/constructs/lib/construct.d.ts:289

The tree node.

Inherited from​

Construct.node

testSfn​

readonly testSfn: StateMachine

Defined in: packages/depot-cdk/src/stage-depot-e2e-test.ts:194

Methods​

toString()​

toString(): string

Defined in: node_modules/constructs/lib/construct.d.ts:314

Returns a string representation of this construct.

Returns​

string

Inherited from​

Construct.toString

with()​

with(...mixins): IConstruct

Defined in: node_modules/constructs/lib/construct.d.ts:310

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters​

mixins​

...IMixin[]

The mixins to apply

Returns​

IConstruct

This construct for chaining

Inherited from​

Construct.with

isConstruct()​

static isConstruct(x): x is Construct

Defined in: node_modules/constructs/lib/construct.d.ts:285

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters​

x​

any

Any object

Returns​

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from​

Construct.isConstruct