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

ApiNamespace class

Represents a TypeScript namespace declaration.

Signature:

export declare class ApiNamespace 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;
    }
  }
}

Constructors

Constructor Modifiers Description
(constructor)(options)   Constructs a new instance of the ApiNamespace class

Properties

Property Modifiers Type Description
containerKey   string  
kind   ApiItemKind  

Methods

Method Modifiers Description
buildCanonicalReference()   (BETA)
getContainerKey(name) static