@microsoft/api-extractor/lib/analyzer/AstNamespaceExport.js

Analyze the exported API for a TypeScript library and generate reviews, documentation, and .d.ts rollups

"use strict";
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
// See LICENSE in the project root for license information.
Object.defineProperty(exports, "__esModule", { value: true });
exports.AstNamespaceExport = void 0;
const AstNamespaceImport_1 = require("./AstNamespaceImport");
/**
 * `AstNamespaceExport` represents a namespace that is created implicitly and exported by a statement
 * such as `export * as example from "./file";`
 *
 * @remarks
 *
 * A typical input looks like this:
 * ```ts
 * // Suppose that example.ts exports two functions f1() and f2().
 * export * as example from "./file";
 * ```
 *
 * API Extractor's .d.ts rollup will transform it into an explicit namespace, like this:
 * ```ts
 * declare f1(): void;
 * declare f2(): void;
 *
 * export declare namespace example {
 *   export {
 *     f1,
 *     f2
 *   }
 * }
 * ```
 *
 * The current implementation does not attempt to relocate f1()/f2() to be inside the `namespace`
 * because other type signatures may reference them directly (without using the namespace qualifier).
 * The AstNamespaceExports behaves the same as AstNamespaceImport, it just also has the inline export for the craeted namespace.
 */
class AstNamespaceExport extends AstNamespaceImport_1.AstNamespaceImport {
    constructor(options) {
        super(options);
    }
}
exports.AstNamespaceExport = AstNamespaceExport;
//# sourceMappingURL=AstNamespaceExport.js.map