60 lines
2.3 KiB
JavaScript
60 lines
2.3 KiB
JavaScript
"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.ApiNamespace = void 0;
|
|
const DeclarationReference_1 = require("@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference");
|
|
const ApiItem_1 = require("../items/ApiItem");
|
|
const ApiItemContainerMixin_1 = require("../mixins/ApiItemContainerMixin");
|
|
const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem");
|
|
const ApiReleaseTagMixin_1 = require("../mixins/ApiReleaseTagMixin");
|
|
const ApiNameMixin_1 = require("../mixins/ApiNameMixin");
|
|
const ApiExportedMixin_1 = require("../mixins/ApiExportedMixin");
|
|
/**
|
|
* Represents a TypeScript namespace declaration.
|
|
*
|
|
* @remarks
|
|
*
|
|
* This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
|
|
* API declarations.
|
|
*
|
|
* `ApiNamespace` represents a TypeScript declaration such `X` or `Y` in this example:
|
|
*
|
|
* ```ts
|
|
* export namespace X {
|
|
* export namespace Y {
|
|
* export interface IWidget {
|
|
* render(): void;
|
|
* }
|
|
* }
|
|
* }
|
|
* ```
|
|
*
|
|
* @public
|
|
*/
|
|
class ApiNamespace extends (0, ApiItemContainerMixin_1.ApiItemContainerMixin)((0, ApiNameMixin_1.ApiNameMixin)((0, ApiReleaseTagMixin_1.ApiReleaseTagMixin)((0, ApiExportedMixin_1.ApiExportedMixin)(ApiDeclaredItem_1.ApiDeclaredItem)))) {
|
|
constructor(options) {
|
|
super(options);
|
|
}
|
|
static getContainerKey(name) {
|
|
return `${name}|${ApiItem_1.ApiItemKind.Namespace}`;
|
|
}
|
|
/** @override */
|
|
get kind() {
|
|
return ApiItem_1.ApiItemKind.Namespace;
|
|
}
|
|
/** @override */
|
|
get containerKey() {
|
|
return ApiNamespace.getContainerKey(this.name);
|
|
}
|
|
/** @beta @override */
|
|
buildCanonicalReference() {
|
|
const nameComponent = DeclarationReference_1.DeclarationReference.parseComponent(this.name);
|
|
const navigation = this.isExported ? "." /* Navigation.Exports */ : "~" /* Navigation.Locals */;
|
|
return (this.parent ? this.parent.canonicalReference : DeclarationReference_1.DeclarationReference.empty())
|
|
.addNavigationStep(navigation, nameComponent)
|
|
.withMeaning("namespace" /* Meaning.Namespace */);
|
|
}
|
|
}
|
|
exports.ApiNamespace = ApiNamespace;
|
|
//# sourceMappingURL=ApiNamespace.js.map
|