Functions — github.com/aws/constructs

CodeHub MCPcopy Create free account

hub / github.com/aws/constructs / functions

Functions57 in github.com/aws/constructs

⨍ Functions 57 ◇ Types & classes 31

↓ 5 callersMethodaddValidation

* Adds a validation to this construct. * * When `node.validate()` is called, the `validate()` method will be called on * all validations and

src/construct.ts:444

↓ 4 callersMethodof

* Returns the node associated with a construct. * @param construct the construct * * @deprecated use `construct.node` instead

src/construct.ts:46

↓ 3 callersMethodadd

* Add a construct to the dependency roots

src/dependency.ts:46

↓ 3 callersMethodtryFindChild

* Return a direct child by id, or undefined * * @param id Identifier of direct child * @returns the child if found, or undefined

src/construct.ts:131

↓ 3 callersMethodvalidate

* Validate the current construct. * * This method can be implemented by derived constructs in order to perform * validation logic. It is call

src/construct.ts:615

↓ 2 callersMethodfindAll

* Return this construct and all of its children in the given order

src/construct.ts:197

↓ 2 callersMethodremoveDependency

* Remove an ordering dependency on a Dependenable (a construct or set of constructs) * * This removes any dependency added using `node.addDepend

src/construct.ts:398

↓ 2 callersFunctionsanitizeId

* Return a sanitized version of an arbitrary string, so it can be used as an ID

src/construct.ts:638

↓ 2 callersMethodsetContext

* This can be used to set contextual values. * Context must be set before any children are added, since children may consult context info during co

src/construct.ts:224

↓ 2 callersMethodwith

* Applies one or more mixins to this construct. * * Mixins are applied in order. The list of constructs is captured at the * start of the cal

src/construct.ts:28

↓ 1 callersMethodaddChild

* Adds a child construct to this node. * * @param child The child construct * @param childName The type name of the child construct. * @re

src/construct.ts:502

↓ 1 callersMethodaddDependency

* Add an ordering dependency on a Dependable (a construct or set of constructs) * * It is up to the target document language to decide what an o

src/construct.ts:383

↓ 1 callersMethodaddMetadata

* Adds a metadata entry to this construct. * Entries are arbitrary values and will also include a stack trace to allow tracing back to * the cod

src/construct.ts:303

↓ 1 callersFunctionaddressOf

(components: string[])

src/private/uniqueid.ts:16

↓ 1 callersMethodapplyTo

* Applies the mixin functionality to the target construct.

src/mixin.ts:16

↓ 1 callersFunctioncaptureStackTrace

(below?: Function)

src/private/stack-trace.ts:2

↓ 1 callersFunctioncreateTree

(context?: any)

test/construct.test.ts:692

↓ 1 callersFunctionexists

test/construct.test.ts:326

↓ 1 callersMethodfindChild

* Return a direct child by id * * Throws an error if the child is not found. * * @param id Identifier of direct child * @returns Child

src/construct.ts:143

↓ 1 callersMethodgetAllContext

* Retrieves the all context of a node from tree context. * * Context is usually initialized at the root, but can be overridden at any point in t

src/construct.ts:263

↓ 1 callersMethodgetContext

* Retrieves a value from tree context if present. Otherwise, would throw an error. * * Context is usually initialized at the root, but can be ov

src/construct.ts:243

↓ 1 callersMethodisConstruct

* Checks if `x` is a construct. * * Use this method instead of `instanceof` to properly detect `Construct` * instances, even when the constru

src/construct.ts:554

↓ 1 callersMethodlock

* Locks this construct from allowing more children to be added. After this * call, no more children can be added to this construct or to any childr

src/construct.ts:468

↓ 1 callersMethodsupports

* Determines whether this mixin can be applied to the given construct.

src/mixin.ts:11

↓ 1 callersMethodtoString

* Returns a string representation of this construct.

src/construct.ts:598

↓ 1 callersMethodtryGetContext

* Retrieves a value from tree context. * * Context is usually initialized at the root, but can be overridden at any point in the tree. * *

src/construct.ts:276

↓ 1 callersMethodtryRemoveChild

* Remove the child with the given name, if present. * * @returns Whether a child with the given name was deleted.

src/construct.ts:430

↓ 1 callersFunctionvalidateTree

(root: Construct)

test/construct.test.ts:386

* Returns an opaque tree-unique address for this construct. * * Addresses are 42 characters hexadecimal strings. They begin with "c8" * follo

src/construct.ts:117

* All direct children of this construct.

src/construct.ts:190

Methodconstructor

Methodconstructor

(scope: Construct, id: string)

test/construct.test.ts:348

Methodconstructor

(scope: Construct, id: string)

test/construct.test.ts:356

Methodconstructor

(scope: Construct, id: string)

test/construct.test.ts:364

Methodconstructor

test/construct.test.ts:374

Methodconstructor

(scope: Construct, id: string)

test/construct.test.ts:712

Methodconstructor

(...deps: IDependable[])

src/dependency.ts:27

Methodconstructor

(private readonly host: Construct, scope: IConstruct, id: string)

src/construct.ts:73

Methodconstructor

* Creates a new construct node. * * @param scope The scope in which to define this construct * @param id The scoped construct ID. Must be uni

src/construct.ts:571

Methodconstructor

* Creates a new root construct node. * * @param id The scoped construct ID. Must be unique amongst siblings. If * the ID includes a path sepa

src/construct.ts:690

MethoddefaultChild

* Returns the child construct that has the id `Default` or `Resource`. * This is usually the construct that provides the bulk of the underlying fun

src/construct.ts:159

Methoddependencies

* Constructs that this construct depends on directly * * This expands the sets of `Dependables` to the set of `Constructs` that they * repres

src/construct.ts:413

FunctiondependencyRoots

test/construct.test.ts:594

MethoddependencyRoots

src/dependency.ts:31

* Return the matching Dependable for the given class instance. * @deprecated use `of`

src/dependency.ts:98

src/construct.ts:309

Functionimplement

* Turn any object into an IDependable.

src/dependency.ts:76

* Returns true if this construct or the scopes in which it is defined are * locked.

src/construct.ts:354

* An immutable array of metadata objects associated with this construct. * This can be used, for example, to implement support for deprecation noti

src/construct.ts:287

* Return the matching Dependable for the given class instance.

src/dependency.ts:86

* The full, absolute path of this construct in the tree. * * Components are separated by '/'.

src/construct.ts:92

* Returns the root of the construct tree. * @returns The root of the construct tree.

src/construct.ts:346

* All parent scopes of this construct. * * @returns a list of parent scopes. The last element in the list will always * be the current constr

src/construct.ts:330

* Validates this construct. * * Invokes the `validate()` method on all validations added through * `addValidation()`. * * @returns an a

src/construct.ts:460

(c: IConstruct)

src/construct.ts:202

* Applies one or more mixins to this construct. * * Mixins are applied in order. The list of constructs is captured at the * start of the cal

src/construct.ts:483

* Applies one or more mixins to this construct. * * Mixins are applied in order. The list of constructs is captured at the * start of the cal

src/construct.ts:591