48 lines
2.0 KiB
TypeScript
48 lines
2.0 KiB
TypeScript
|
import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference';
|
||
|
|
import { ApiItemKind } from '../items/ApiItem';
|
||
|
|
import { type IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem';
|
||
|
|
import { type IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin';
|
||
|
|
import { type IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';
|
||
|
|
import { type IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';
|
||
|
|
import { type IApiReadonlyMixinOptions, ApiReadonlyMixin } from '../mixins/ApiReadonlyMixin';
|
||
|
|
/**
|
||
|
|
* Constructor options for {@link ApiIndexSignature}.
|
||
|
|
* @public
|
||
|
|
*/
|
||
|
|
export interface IApiIndexSignatureOptions extends IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiReadonlyMixinOptions, IApiDeclaredItemOptions {
|
||
|
|
}
|
||
|
|
declare const ApiIndexSignature_base: typeof ApiDeclaredItem & (new (...args: any[]) => ApiReadonlyMixin) & (new (...args: any[]) => ApiReturnTypeMixin) & (new (...args: any[]) => ApiReleaseTagMixin) & (new (...args: any[]) => ApiParameterListMixin);
|
||
|
|
/**
|
||
|
|
* Represents a TypeScript index signature.
|
||
|
|
*
|
||
|
|
* @remarks
|
||
|
|
*
|
||
|
|
* This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of
|
||
|
|
* API declarations.
|
||
|
|
*
|
||
|
|
* `ApiIndexSignature` represents a TypeScript declaration such as `[x: number]: number` in this example:
|
||
|
|
*
|
||
|
|
* ```ts
|
||
|
|
* export interface INumberTable {
|
||
|
|
* // An index signature
|
||
|
|
* [value: number]: number;
|
||
|
|
*
|
||
|
|
* // An overloaded index signature
|
||
|
|
* [name: string]: number;
|
||
|
|
* }
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @public
|
||
|
|
*/
|
||
|
|
export declare class ApiIndexSignature extends ApiIndexSignature_base {
|
||
|
|
constructor(options: IApiIndexSignatureOptions);
|
||
|
|
static getContainerKey(overloadIndex: number): string;
|
||
|
|
/** @override */
|
||
|
|
get kind(): ApiItemKind;
|
||
|
|
/** @override */
|
||
|
|
get containerKey(): string;
|
||
|
|
/** @beta @override */
|
||
|
|
buildCanonicalReference(): DeclarationReference;
|
||
|
|
}
|
||
|
|
export {};
|
||
|
|
//# sourceMappingURL=ApiIndexSignature.d.ts.map
|