Class Node

src/construct.ts:34–495

 * Represents the construct node in the scope tree.
 */
export class Node {
  /**
   * Separator used to delimit construct path components.
   */
  public static readonly PATH_SEP = '/';

  /**
   * Returns the node associated with a construct.
   * @param construct the construct
   *
   * @deprecated use `construct.node` instead
   */
  public static of(construct: IConstruct): Node {
    return construct.node;
  }

  /**
   * Returns the scope in which this construct is defined.
   *
   * The value is `undefined` at the root of the construct scope tree.
   */
  public readonly scope?: IConstruct;

  /**
   * The id of this construct within the current scope.
   *
   * This is a scope-unique id. To obtain an app-unique id for this construct, use `addr`.
   */
  public readonly id: string;

  private _locked = false; // if this is "true", addChild will fail
  private _children: { [id: string]: IConstruct } | undefined;
  private _context: { [key: string]: any } | undefined;
  private _metadata: Array<MetadataEntry> | undefined;
  private _dependencies: Set<IDependable> | undefined;
  private _defaultChild: IConstruct | undefined;
  private _validations: Array<IValidation> | undefined;
  private _addr?: string; // cache

  public constructor(private readonly host: Construct, scope: IConstruct, id: string) {
    id = id ?? ''; // if undefined, convert to empty string

    this.id = sanitizeId(id);
    this.scope = scope;

    if (scope && !this.id) {
      throw new Error('Only root constructs may have an empty ID');
    }

    // add to parent scope
    scope?.node.addChild(host, this.id);
  }

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