Skip to content

⬅️ Back to Table of Contents

📄 spec.ts

📊 Analysis Summary

Metric Count
📦 Imports 6
📐 Interfaces 3
📑 Type Aliases 1

📚 Table of Contents

🛠️ File Location:

📂 packages/ast-spec/src/declaration/TSImportEqualsDeclaration/spec.ts

📦 Imports

Name Source
AST_NODE_TYPES ../../ast-node-types
BaseNode ../../base/BaseNode
Identifier ../../expression/Identifier/spec
TSExternalModuleReference ../../special/TSExternalModuleReference/spec
TSQualifiedName ../../type/TSQualifiedName/spec
ImportKind ../ExportAndImportKind

Interfaces

TSImportEqualsDeclarationBase

Interface Code
interface TSImportEqualsDeclarationBase extends BaseNode {
  type: AST_NODE_TYPES.TSImportEqualsDeclaration;
  /**
   * The locally imported name.
   */
  id: Identifier;
  /**
   * The kind of the import. Always `'value'` unless `moduleReference` is a
   * `TSExternalModuleReference`.
   */
  importKind: ImportKind;
  /**
   * The value being aliased.
   * @example
   * ```ts
   * import F1 = A;
   * import F2 = A.B.C;
   * import F3 = require('mod');
   * ```
   */
  moduleReference: Identifier | TSExternalModuleReference | TSQualifiedName;
}

Properties

Name Type Optional Description
type AST_NODE_TYPES.TSImportEqualsDeclaration
id Identifier
importKind ImportKind
moduleReference Identifier | TSExternalModuleReference | TSQualifiedName

TSImportEqualsNamespaceDeclaration

Interface Code
export interface TSImportEqualsNamespaceDeclaration
  extends TSImportEqualsDeclarationBase {
  /**
   * The kind of the import.
   */
  importKind: 'value';
  /**
   * The value being aliased.
   * ```
   * import F1 = A;
   * import F2 = A.B.C;
   * ```
   */
  moduleReference: Identifier | TSQualifiedName;
}

Properties

Name Type Optional Description
importKind 'value'
moduleReference Identifier | TSQualifiedName

TSImportEqualsRequireDeclaration

Interface Code
export interface TSImportEqualsRequireDeclaration
  extends TSImportEqualsDeclarationBase {
  /**
   * The kind of the import.
   */
  importKind: ImportKind;
  /**
   * The value being aliased.
   * ```
   * import F3 = require('mod');
   * ```
   */
  moduleReference: TSExternalModuleReference;
}

Properties

Name Type Optional Description
importKind ImportKind
moduleReference TSExternalModuleReference

Type Aliases

TSImportEqualsDeclaration

type TSImportEqualsDeclaration = | TSImportEqualsNamespaceDeclaration
  | TSImportEqualsRequireDeclaration;