constructs.Construct

class Construct

LanguageType name
.NETConstructs.Construct
Javasoftware.constructs.Construct
Pythonconstructs.Construct
TypeScript (source)constructs » Construct

Implements IConstruct, IDependable

Represents the building block of the construct graph.

All constructs besides the root construct must be created within the scope of another construct.

Initializer

new Construct(scope: Construct, id: string)

Parameters

  • scope Construct — The scope in which to define this construct.
  • id string — The scoped construct ID.

Creates a new construct node.

Properties

NameTypeDescription
nodeNodeThe tree node.

node

Type: Node

The tree node.

Methods

NameDescription
toString()Returns a string representation of this construct.
static isConstruct(x)Checks if x is a construct.

toString()

public toString(): string

Returns

  • string

Returns a string representation of this construct.


static isConstruct(x)

public static isConstruct(x: any): boolean

Parameters

  • x any — Any object.

Returns

  • boolean

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.