api-extractor-model.apiindexsignature

ApiIndexSignature class

Represents a TypeScript index signature.

Signature:

export declare class ApiIndexSignature extends ApiIndexSignature_base 

Extends: ApiIndexSignature_base

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

ApiIndexSignature represents a TypeScript declaration such as [x: number]: number in this example:

export interface INumberTable {
  // An index signature
  [value: number]: number;

  // An overloaded index signature
  [name: string]: number;
}

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

Property	Modifiers	Type	Description
containerKey	`readonly`	string
kind	`readonly`	ApiItemKind

Method	Modifiers	Description
buildCanonicalReference()		*(BETA)*
getContainerKey(overloadIndex)	`static`