RoadmapShopEvents
Skip to main content

Home > @microsoft/api-extractor-model > ApiNamespace

ApiNamespace class

Represents a TypeScript namespace declaration.

Signature:

export declare class ApiNamespace extends ApiNamespace_base 

Extends: ApiNamespace_base

Remarks

This is part of the ApiModel hierarchy of classes, which are serializable representations of API declarations.

ApiNamespace represents a TypeScript declaration such X or Y in this example:

export namespace X {
export namespace Y {
export interface IWidget {
render(): void;
}
}
}

(Some inherited members may not be shown because they are not represented in the documentation.)

Constructors

ConstructorModifiersDescription
(constructor)(options)Constructs a new instance of the ApiNamespace class

Properties

PropertyModifiersTypeDescription
containerKeyreadonlystring
kindreadonlyApiItemKind

Methods

MethodModifiersDescription
buildCanonicalReference()(BETA)
getContainerKey(name)static