@microsoft/api-extractor-model 7.9.7 → 7.10.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.json +75 -0
- package/CHANGELOG.md +29 -1
- package/README.md +9 -0
- package/dist/rollup.d.ts +62 -62
- package/dist/tsdoc-metadata.json +1 -1
- package/lib/aedoc/AedocDefinitions.d.ts +1 -1
- package/lib/aedoc/AedocDefinitions.d.ts.map +1 -1
- package/lib/aedoc/AedocDefinitions.js +2 -1
- package/lib/aedoc/AedocDefinitions.js.map +1 -1
- package/lib/aedoc/ReleaseTag.js +1 -0
- package/lib/aedoc/ReleaseTag.js.map +1 -1
- package/lib/index.js +37 -37
- package/lib/index.js.map +1 -1
- package/lib/items/ApiDeclaredItem.d.ts +2 -2
- package/lib/items/ApiDeclaredItem.d.ts.map +1 -1
- package/lib/items/ApiDeclaredItem.js +1 -0
- package/lib/items/ApiDeclaredItem.js.map +1 -1
- package/lib/items/ApiDocumentedItem.d.ts +1 -1
- package/lib/items/ApiDocumentedItem.d.ts.map +1 -1
- package/lib/items/ApiDocumentedItem.js +21 -1
- package/lib/items/ApiDocumentedItem.js.map +1 -1
- package/lib/items/ApiItem.d.ts +6 -6
- package/lib/items/ApiItem.d.ts.map +1 -1
- package/lib/items/ApiItem.js +1 -0
- package/lib/items/ApiItem.js.map +1 -1
- package/lib/items/ApiPropertyItem.d.ts +1 -1
- package/lib/items/ApiPropertyItem.d.ts.map +1 -1
- package/lib/items/ApiPropertyItem.js +1 -0
- package/lib/items/ApiPropertyItem.js.map +1 -1
- package/lib/mixins/ApiItemContainerMixin.js +1 -0
- package/lib/mixins/ApiItemContainerMixin.js.map +1 -1
- package/lib/mixins/ApiNameMixin.js +1 -0
- package/lib/mixins/ApiNameMixin.js.map +1 -1
- package/lib/mixins/ApiParameterListMixin.js +1 -0
- package/lib/mixins/ApiParameterListMixin.js.map +1 -1
- package/lib/mixins/ApiReleaseTagMixin.d.ts.map +1 -1
- package/lib/mixins/ApiReleaseTagMixin.js +4 -1
- package/lib/mixins/ApiReleaseTagMixin.js.map +1 -1
- package/lib/mixins/ApiReturnTypeMixin.js +1 -0
- package/lib/mixins/ApiReturnTypeMixin.js.map +1 -1
- package/lib/mixins/ApiStaticMixin.js +1 -0
- package/lib/mixins/ApiStaticMixin.js.map +1 -1
- package/lib/mixins/ApiTypeParameterListMixin.js +1 -0
- package/lib/mixins/ApiTypeParameterListMixin.js.map +1 -1
- package/lib/mixins/Excerpt.d.ts +5 -5
- package/lib/mixins/Excerpt.d.ts.map +1 -1
- package/lib/mixins/Excerpt.js +1 -0
- package/lib/mixins/Excerpt.js.map +1 -1
- package/lib/model/ApiCallSignature.d.ts +2 -2
- package/lib/model/ApiCallSignature.d.ts.map +1 -1
- package/lib/model/ApiCallSignature.js +1 -0
- package/lib/model/ApiCallSignature.js.map +1 -1
- package/lib/model/ApiClass.d.ts +3 -3
- package/lib/model/ApiClass.d.ts.map +1 -1
- package/lib/model/ApiClass.js +1 -0
- package/lib/model/ApiClass.js.map +1 -1
- package/lib/model/ApiConstructSignature.d.ts +2 -2
- package/lib/model/ApiConstructSignature.d.ts.map +1 -1
- package/lib/model/ApiConstructSignature.js +1 -0
- package/lib/model/ApiConstructSignature.js.map +1 -1
- package/lib/model/ApiConstructor.d.ts +2 -2
- package/lib/model/ApiConstructor.d.ts.map +1 -1
- package/lib/model/ApiConstructor.js +1 -0
- package/lib/model/ApiConstructor.js.map +1 -1
- package/lib/model/ApiEntryPoint.d.ts +3 -3
- package/lib/model/ApiEntryPoint.d.ts.map +1 -1
- package/lib/model/ApiEntryPoint.js +1 -0
- package/lib/model/ApiEntryPoint.js.map +1 -1
- package/lib/model/ApiEnum.d.ts +3 -3
- package/lib/model/ApiEnum.d.ts.map +1 -1
- package/lib/model/ApiEnum.js +1 -0
- package/lib/model/ApiEnum.js.map +1 -1
- package/lib/model/ApiEnumMember.d.ts +2 -2
- package/lib/model/ApiEnumMember.d.ts.map +1 -1
- package/lib/model/ApiEnumMember.js +1 -0
- package/lib/model/ApiEnumMember.js.map +1 -1
- package/lib/model/ApiFunction.d.ts +2 -2
- package/lib/model/ApiFunction.d.ts.map +1 -1
- package/lib/model/ApiFunction.js +1 -0
- package/lib/model/ApiFunction.js.map +1 -1
- package/lib/model/ApiIndexSignature.d.ts +2 -2
- package/lib/model/ApiIndexSignature.d.ts.map +1 -1
- package/lib/model/ApiIndexSignature.js +1 -0
- package/lib/model/ApiIndexSignature.js.map +1 -1
- package/lib/model/ApiInterface.d.ts +3 -3
- package/lib/model/ApiInterface.d.ts.map +1 -1
- package/lib/model/ApiInterface.js +1 -0
- package/lib/model/ApiInterface.js.map +1 -1
- package/lib/model/ApiMethod.d.ts +2 -2
- package/lib/model/ApiMethod.d.ts.map +1 -1
- package/lib/model/ApiMethod.js +1 -0
- package/lib/model/ApiMethod.js.map +1 -1
- package/lib/model/ApiMethodSignature.d.ts +2 -2
- package/lib/model/ApiMethodSignature.d.ts.map +1 -1
- package/lib/model/ApiMethodSignature.js +1 -0
- package/lib/model/ApiMethodSignature.js.map +1 -1
- package/lib/model/ApiModel.d.ts +3 -3
- package/lib/model/ApiModel.d.ts.map +1 -1
- package/lib/model/ApiModel.js +1 -0
- package/lib/model/ApiModel.js.map +1 -1
- package/lib/model/ApiNamespace.d.ts +2 -2
- package/lib/model/ApiNamespace.d.ts.map +1 -1
- package/lib/model/ApiNamespace.js +1 -0
- package/lib/model/ApiNamespace.js.map +1 -1
- package/lib/model/ApiPackage.d.ts +3 -3
- package/lib/model/ApiPackage.d.ts.map +1 -1
- package/lib/model/ApiPackage.js +1 -0
- package/lib/model/ApiPackage.js.map +1 -1
- package/lib/model/ApiProperty.d.ts +2 -2
- package/lib/model/ApiProperty.d.ts.map +1 -1
- package/lib/model/ApiProperty.js +1 -0
- package/lib/model/ApiProperty.js.map +1 -1
- package/lib/model/ApiPropertySignature.d.ts +2 -2
- package/lib/model/ApiPropertySignature.d.ts.map +1 -1
- package/lib/model/ApiPropertySignature.js +1 -0
- package/lib/model/ApiPropertySignature.js.map +1 -1
- package/lib/model/ApiTypeAlias.d.ts +2 -2
- package/lib/model/ApiTypeAlias.d.ts.map +1 -1
- package/lib/model/ApiTypeAlias.js +1 -0
- package/lib/model/ApiTypeAlias.js.map +1 -1
- package/lib/model/ApiVariable.d.ts +2 -2
- package/lib/model/ApiVariable.d.ts.map +1 -1
- package/lib/model/ApiVariable.js +1 -0
- package/lib/model/ApiVariable.js.map +1 -1
- package/lib/model/Deserializer.js +1 -0
- package/lib/model/Deserializer.js.map +1 -1
- package/lib/model/DeserializerContext.js +1 -0
- package/lib/model/DeserializerContext.js.map +1 -1
- package/lib/model/HeritageType.js +1 -0
- package/lib/model/HeritageType.js.map +1 -1
- package/lib/model/ModelReferenceResolver.js +1 -0
- package/lib/model/ModelReferenceResolver.js.map +1 -1
- package/lib/model/Parameter.d.ts +1 -1
- package/lib/model/Parameter.d.ts.map +1 -1
- package/lib/model/Parameter.js +1 -0
- package/lib/model/Parameter.js.map +1 -1
- package/lib/model/TypeParameter.d.ts +1 -1
- package/lib/model/TypeParameter.d.ts.map +1 -1
- package/lib/model/TypeParameter.js +1 -0
- package/lib/model/TypeParameter.js.map +1 -1
- package/package.json +6 -6
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiNameMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiNameMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D
|
|
1
|
+
{"version":3,"file":"ApiNameMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiNameMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D;;;AAiB5D,MAAM,KAAK,GAAkB,MAAM,CAAC,oBAAoB,CAAC,CAAC;AAgC1D;;;;;;;GAOG;AACH,SAAgB,YAAY,CAC1B,SAAqB;AACrB,8DAA8D;;IAE9D,MAAe,UAAW,SAAQ,SAAS;QAGzC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAEf,MAAM,OAAO,GAAyB,IAAI,CAAC,CAAC,CAAC,CAAC;YAC9C,IAAI,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;QAC7B,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAAsC,EACtC,OAA4B,EAC5B,UAA6B;YAE7B,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAE1D,OAAO,CAAC,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;QACjC,CAAC;QAED,IAAW,IAAI;YACb,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;QAED,gBAAgB;QAChB,IAAW,WAAW;YACpB,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;QACrB,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAAsC;YACzD,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,UAAU,CAAC,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QAC9B,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AA5CD,oCA4CC;AAED;;;GAGG;AACH,WAAiB,YAAY;IAC3B;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC;IAFe,0BAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAa5B","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.s\r\n\r\nimport { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';\r\nimport { DeserializerContext } from '../model/DeserializerContext';\r\n\r\n/**\r\n * Constructor options for {@link (IApiNameMixinOptions:interface)}.\r\n * @public\r\n */\r\nexport interface IApiNameMixinOptions extends IApiItemOptions {\r\n name: string;\r\n}\r\n\r\nexport interface IApiNameMixinJson extends IApiItemJson {\r\n name: string;\r\n}\r\n\r\nconst _name: unique symbol = Symbol('ApiNameMixin._name');\r\n\r\n/**\r\n * The mixin base class for API items that have a name. For example, a class has a name, but a class constructor\r\n * does not.\r\n *\r\n * @remarks\r\n *\r\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\r\n * API declarations. The non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\r\n * TypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\r\n * features that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\r\n * to extend more than one base class). The \"mixin\" is a TypeScript merged declaration with three components:\r\n * the function that generates a subclass, an interface that describes the members of the subclass, and\r\n * a namespace containing static members of the class.\r\n *\r\n * @public\r\n */\r\n// eslint-disable-next-line @typescript-eslint/naming-convention\r\nexport interface ApiNameMixin extends ApiItem {\r\n /**\r\n * The exported name of this API item.\r\n *\r\n * @remarks\r\n * Note that due tue type aliasing, the exported name may be different from the locally declared name.\r\n */\r\n readonly name: string;\r\n\r\n /** @override */\r\n serializeInto(jsonObject: Partial<IApiItemJson>): void;\r\n}\r\n\r\n/**\r\n * Mixin function for {@link (ApiNameMixin:interface)}.\r\n *\r\n * @param baseClass - The base class to be extended\r\n * @returns A child class that extends baseClass, adding the {@link (ApiNameMixin:interface)} functionality.\r\n *\r\n * @public\r\n */\r\nexport function ApiNameMixin<TBaseClass extends IApiItemConstructor>(\r\n baseClass: TBaseClass\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n): TBaseClass & (new (...args: any[]) => ApiNameMixin) {\r\n abstract class MixedClass extends baseClass implements ApiNameMixin {\r\n public readonly [_name]: string;\r\n\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n public constructor(...args: any[]) {\r\n super(...args);\r\n\r\n const options: IApiNameMixinOptions = args[0];\r\n this[_name] = options.name;\r\n }\r\n\r\n /** @override */\r\n public static onDeserializeInto(\r\n options: Partial<IApiNameMixinOptions>,\r\n context: DeserializerContext,\r\n jsonObject: IApiNameMixinJson\r\n ): void {\r\n baseClass.onDeserializeInto(options, context, jsonObject);\r\n\r\n options.name = jsonObject.name;\r\n }\r\n\r\n public get name(): string {\r\n return this[_name];\r\n }\r\n\r\n /** @override */\r\n public get displayName(): string {\r\n return this[_name];\r\n }\r\n\r\n /** @override */\r\n public serializeInto(jsonObject: Partial<IApiNameMixinJson>): void {\r\n super.serializeInto(jsonObject);\r\n\r\n jsonObject.name = this.name;\r\n }\r\n }\r\n\r\n return MixedClass;\r\n}\r\n\r\n/**\r\n * Static members for {@link (ApiNameMixin:interface)}.\r\n * @public\r\n */\r\nexport namespace ApiNameMixin {\r\n /**\r\n * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiNameMixin` mixin.\r\n *\r\n * @remarks\r\n *\r\n * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of\r\n * the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however\r\n * the TypeScript type system cannot invoke a runtime test.)\r\n */\r\n export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiNameMixin {\r\n return apiItem.hasOwnProperty(_name);\r\n }\r\n}\r\n"]}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
3
3
|
// See LICENSE in the project root for license information.s
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.ApiParameterListMixin = void 0;
|
|
5
6
|
const Parameter_1 = require("../model/Parameter");
|
|
6
7
|
const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem");
|
|
7
8
|
const node_core_library_1 = require("@rushstack/node-core-library");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiParameterListMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiParameterListMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D
|
|
1
|
+
{"version":3,"file":"ApiParameterListMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiParameterListMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D;;;AAG5D,kDAA+C;AAC/C,8DAA2D;AAE3D,oEAA6D;AA0B7D,MAAM,cAAc,GAAkB,MAAM,CAAC,sCAAsC,CAAC,CAAC;AACrF,MAAM,WAAW,GAAkB,MAAM,CAAC,mCAAmC,CAAC,CAAC;AAwD/E;;;;;;;GAOG;AACH,SAAgB,qBAAqB,CACnC,SAAqB;AACrB,8DAA8D;;IAE9D,MAAe,UAAW,SAAQ,SAAS;QAIzC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAEf,MAAM,OAAO,GAAkC,IAAI,CAAC,CAAC,CAAC,CAAC;YACvD,IAAI,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,aAAa,CAAC;YAE7C,IAAI,CAAC,WAAW,CAAC,GAAG,EAAE,CAAC;YAEvB,IAAI,IAAI,YAAY,iCAAe,EAAE;gBACnC,IAAI,OAAO,CAAC,UAAU,EAAE;oBACtB,KAAK,MAAM,gBAAgB,IAAI,OAAO,CAAC,UAAU,EAAE;wBACjD,MAAM,SAAS,GAAc,IAAI,qBAAS,CAAC;4BACzC,IAAI,EAAE,gBAAgB,CAAC,aAAa;4BACpC,oBAAoB,EAAE,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,uBAAuB,CAAC;4BACjF,MAAM,EAAE,IAAI;yBACb,CAAC,CAAC;wBAEH,IAAI,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;qBACnC;iBACF;aACF;iBAAM;gBACL,MAAM,IAAI,iCAAa,CAAC,4EAA4E,CAAC,CAAC;aACvG;QACH,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAA+C,EAC/C,OAA4B,EAC5B,UAAiC;YAEjC,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAE1D,OAAO,CAAC,aAAa,GAAG,UAAU,CAAC,aAAa,CAAC;YACjD,OAAO,CAAC,UAAU,GAAG,UAAU,CAAC,UAAU,IAAI,EAAE,CAAC;QACnD,CAAC;QAED,IAAW,aAAa;YACtB,OAAO,IAAI,CAAC,cAAc,CAAC,CAAC;QAC9B,CAAC;QAED,IAAW,UAAU;YACnB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC;QAC3B,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAA0C;YAC7D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,UAAU,CAAC,aAAa,GAAG,IAAI,CAAC,aAAa,CAAC;YAE9C,MAAM,gBAAgB,GAA2B,EAAE,CAAC;YACpD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE;gBACvC,gBAAgB,CAAC,IAAI,CAAC;oBACpB,aAAa,EAAE,SAAS,CAAC,IAAI;oBAC7B,uBAAuB,EAAE,SAAS,CAAC,oBAAoB,CAAC,UAAU;iBACnE,CAAC,CAAC;aACJ;YAED,UAAU,CAAC,UAAU,GAAG,gBAAgB,CAAC;QAC3C,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAzED,sDAyEC;AAED;;;GAGG;AACH,WAAiB,qBAAqB;IACpC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC;IAFe,mCAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,qBAAqB,GAArB,6BAAqB,KAArB,6BAAqB,QAarC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.s\r\n\r\nimport { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';\r\nimport { Parameter } from '../model/Parameter';\r\nimport { ApiDeclaredItem } from '../items/ApiDeclaredItem';\r\nimport { IExcerptTokenRange } from './Excerpt';\r\nimport { InternalError } from '@rushstack/node-core-library';\r\nimport { DeserializerContext } from '../model/DeserializerContext';\r\n\r\n/**\r\n * Represents parameter information that is part of {@link IApiParameterListMixinOptions}\r\n * @public\r\n */\r\nexport interface IApiParameterOptions {\r\n parameterName: string;\r\n parameterTypeTokenRange: IExcerptTokenRange;\r\n}\r\n\r\n/**\r\n * Constructor options for {@link (ApiParameterListMixin:interface)}.\r\n * @public\r\n */\r\nexport interface IApiParameterListMixinOptions extends IApiItemOptions {\r\n overloadIndex: number;\r\n parameters: IApiParameterOptions[];\r\n}\r\n\r\nexport interface IApiParameterListJson extends IApiItemJson {\r\n overloadIndex: number;\r\n parameters: IApiParameterOptions[];\r\n}\r\n\r\nconst _overloadIndex: unique symbol = Symbol('ApiParameterListMixin._overloadIndex');\r\nconst _parameters: unique symbol = Symbol('ApiParameterListMixin._parameters');\r\n\r\n/**\r\n * The mixin base class for API items that can have function parameters (but not necessarily a return value).\r\n *\r\n * @remarks\r\n *\r\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\r\n * API declarations. The non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\r\n * TypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\r\n * features that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\r\n * to extend more than one base class). The \"mixin\" is a TypeScript merged declaration with three components:\r\n * the function that generates a subclass, an interface that describes the members of the subclass, and\r\n * a namespace containing static members of the class.\r\n *\r\n * @public\r\n */\r\n// eslint-disable-next-line @typescript-eslint/naming-convention\r\nexport interface ApiParameterListMixin extends ApiItem {\r\n /**\r\n * When a function has multiple overloaded declarations, this zero-based integer index can be used to unqiuely\r\n * identify them.\r\n *\r\n * @remarks\r\n *\r\n * Consider this overloaded declaration:\r\n *\r\n * ```ts\r\n * export namespace Versioning {\r\n * // TSDoc: Versioning.(addVersions:1)\r\n * export function addVersions(x: number, y: number): number;\r\n *\r\n * // TSDoc: Versioning.(addVersions:2)\r\n * export function addVersions(x: string, y: string): string;\r\n *\r\n * // (implementation)\r\n * export function addVersions(x: number|string, y: number|string): number|string {\r\n * // . . .\r\n * }\r\n * }\r\n * ```\r\n *\r\n * In the above example, there are two overloaded declarations. The overload using numbers will have\r\n * `overloadIndex = 1`. The overload using strings will have `overloadIndex = 2`. The third declaration that\r\n * accepts all possible inputs is considered part of the implementation, and is not processed by API Extractor.\r\n */\r\n readonly overloadIndex: number;\r\n\r\n /**\r\n * The function parameters.\r\n */\r\n readonly parameters: ReadonlyArray<Parameter>;\r\n\r\n serializeInto(jsonObject: Partial<IApiItemJson>): void;\r\n}\r\n\r\n/**\r\n * Mixin function for {@link (ApiParameterListMixin:interface)}.\r\n *\r\n * @param baseClass - The base class to be extended\r\n * @returns A child class that extends baseClass, adding the {@link (ApiParameterListMixin:interface)} functionality.\r\n *\r\n * @public\r\n */\r\nexport function ApiParameterListMixin<TBaseClass extends IApiItemConstructor>(\r\n baseClass: TBaseClass\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n): TBaseClass & (new (...args: any[]) => ApiParameterListMixin) {\r\n abstract class MixedClass extends baseClass implements ApiParameterListMixin {\r\n public readonly [_overloadIndex]: number;\r\n public readonly [_parameters]: Parameter[];\r\n\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n public constructor(...args: any[]) {\r\n super(...args);\r\n\r\n const options: IApiParameterListMixinOptions = args[0];\r\n this[_overloadIndex] = options.overloadIndex;\r\n\r\n this[_parameters] = [];\r\n\r\n if (this instanceof ApiDeclaredItem) {\r\n if (options.parameters) {\r\n for (const parameterOptions of options.parameters) {\r\n const parameter: Parameter = new Parameter({\r\n name: parameterOptions.parameterName,\r\n parameterTypeExcerpt: this.buildExcerpt(parameterOptions.parameterTypeTokenRange),\r\n parent: this\r\n });\r\n\r\n this[_parameters].push(parameter);\r\n }\r\n }\r\n } else {\r\n throw new InternalError('ApiReturnTypeMixin expects a base class that inherits from ApiDeclaredItem');\r\n }\r\n }\r\n\r\n /** @override */\r\n public static onDeserializeInto(\r\n options: Partial<IApiParameterListMixinOptions>,\r\n context: DeserializerContext,\r\n jsonObject: IApiParameterListJson\r\n ): void {\r\n baseClass.onDeserializeInto(options, context, jsonObject);\r\n\r\n options.overloadIndex = jsonObject.overloadIndex;\r\n options.parameters = jsonObject.parameters || [];\r\n }\r\n\r\n public get overloadIndex(): number {\r\n return this[_overloadIndex];\r\n }\r\n\r\n public get parameters(): ReadonlyArray<Parameter> {\r\n return this[_parameters];\r\n }\r\n\r\n /** @override */\r\n public serializeInto(jsonObject: Partial<IApiParameterListJson>): void {\r\n super.serializeInto(jsonObject);\r\n\r\n jsonObject.overloadIndex = this.overloadIndex;\r\n\r\n const parameterObjects: IApiParameterOptions[] = [];\r\n for (const parameter of this.parameters) {\r\n parameterObjects.push({\r\n parameterName: parameter.name,\r\n parameterTypeTokenRange: parameter.parameterTypeExcerpt.tokenRange\r\n });\r\n }\r\n\r\n jsonObject.parameters = parameterObjects;\r\n }\r\n }\r\n\r\n return MixedClass;\r\n}\r\n\r\n/**\r\n * Static members for {@link (ApiParameterListMixin:interface)}.\r\n * @public\r\n */\r\nexport namespace ApiParameterListMixin {\r\n /**\r\n * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiParameterListMixin` mixin.\r\n *\r\n * @remarks\r\n *\r\n * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of\r\n * the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however\r\n * the TypeScript type system cannot invoke a runtime test.)\r\n */\r\n export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiParameterListMixin {\r\n return apiItem.hasOwnProperty(_parameters);\r\n }\r\n}\r\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiReleaseTagMixin.d.ts","sourceRoot":"","sources":["../../src/mixins/ApiReleaseTagMixin.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"ApiReleaseTagMixin.d.ts","sourceRoot":"","sources":["../../src/mixins/ApiReleaseTagMixin.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAGjD;;;GAGG;AACH,MAAM,WAAW,0BAA2B,SAAQ,eAAe;IACjE,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,MAAM,WAAW,uBAAwB,SAAQ,YAAY;IAC3D,UAAU,EAAE,MAAM,CAAC;CACpB;AAID;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,WAAW,kBAAmB,SAAQ,OAAO;IACjD;;;;;;OAMG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAEhC,gBAAgB;IAChB,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,YAAY,CAAC,GAAG,IAAI,CAAC;CACxD;AAED;;;;;;;GAOG;AACH,wBAAgB,kBAAkB,CAAC,UAAU,SAAS,mBAAmB,EACvE,SAAS,EAAE,UAAU,GAEpB,UAAU,GAAG,CAAC,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,kBAAkB,CAAC,CA4C3D;AAED;;;GAGG;AACH,yBAAiB,kBAAkB,CAAC;IAClC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,IAAI,kBAAkB,CAE7E;CACF"}
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
3
3
|
// See LICENSE in the project root for license information.s
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.ApiReleaseTagMixin = void 0;
|
|
6
|
+
const node_core_library_1 = require("@rushstack/node-core-library");
|
|
5
7
|
const ReleaseTag_1 = require("../aedoc/ReleaseTag");
|
|
6
8
|
const _releaseTag = Symbol('ApiReleaseTagMixin._releaseTag');
|
|
7
9
|
/**
|
|
@@ -25,7 +27,8 @@ function ApiReleaseTagMixin(baseClass
|
|
|
25
27
|
/** @override */
|
|
26
28
|
static onDeserializeInto(options, context, jsonObject) {
|
|
27
29
|
baseClass.onDeserializeInto(options, context, jsonObject);
|
|
28
|
-
const deserializedReleaseTag = ReleaseTag_1.ReleaseTag
|
|
30
|
+
const deserializedReleaseTag = node_core_library_1.Enum.tryGetValueByKey(ReleaseTag_1.ReleaseTag, // eslint-disable-line
|
|
31
|
+
jsonObject.releaseTag);
|
|
29
32
|
if (deserializedReleaseTag === undefined) {
|
|
30
33
|
throw new Error(`Failed to deserialize release tag ${JSON.stringify(jsonObject.releaseTag)}`);
|
|
31
34
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiReleaseTagMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiReleaseTagMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D
|
|
1
|
+
{"version":3,"file":"ApiReleaseTagMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiReleaseTagMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D;;;AAE5D,oEAAoD;AAGpD,oDAAiD;AAejD,MAAM,WAAW,GAAkB,MAAM,CAAC,gCAAgC,CAAC,CAAC;AAiC5E;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAChC,SAAqB;AACrB,8DAA8D;;IAE9D,MAAe,UAAW,SAAQ,SAAS;QAGzC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAEf,MAAM,OAAO,GAA+B,IAAI,CAAC,CAAC,CAAC,CAAC;YACpD,IAAI,CAAC,WAAW,CAAC,GAAG,OAAO,CAAC,UAAU,CAAC;QACzC,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAA4C,EAC5C,OAA4B,EAC5B,UAAmC;YAEnC,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAE1D,MAAM,sBAAsB,GAA2B,wBAAI,CAAC,gBAAgB,CAC1E,uBAAiB,EAAE,sBAAsB;YACzC,UAAU,CAAC,UAAU,CACtB,CAAC;YACF,IAAI,sBAAsB,KAAK,SAAS,EAAE;gBACxC,MAAM,IAAI,KAAK,CAAC,qCAAqC,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;aAC/F;YAED,OAAO,CAAC,UAAU,GAAG,sBAAsB,CAAC;QAC9C,CAAC;QAED,IAAW,UAAU;YACnB,OAAO,IAAI,CAAC,WAAW,CAAC,CAAC;QAC3B,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAA4C;YAC/D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,UAAU,CAAC,UAAU,GAAG,uBAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACtD,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AA/CD,gDA+CC;AAED;;;GAGG;AACH,WAAiB,kBAAkB;IACjC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC7C,CAAC;IAFe,gCAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAalC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.s\r\n\r\nimport { Enum } from '@rushstack/node-core-library';\r\n\r\nimport { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';\r\nimport { ReleaseTag } from '../aedoc/ReleaseTag';\r\nimport { DeserializerContext } from '../model/DeserializerContext';\r\n\r\n/**\r\n * Constructor options for {@link (ApiReleaseTagMixin:interface)}.\r\n * @public\r\n */\r\nexport interface IApiReleaseTagMixinOptions extends IApiItemOptions {\r\n releaseTag: ReleaseTag;\r\n}\r\n\r\nexport interface IApiReleaseTagMixinJson extends IApiItemJson {\r\n releaseTag: string;\r\n}\r\n\r\nconst _releaseTag: unique symbol = Symbol('ApiReleaseTagMixin._releaseTag');\r\n\r\n/**\r\n * The mixin base class for API items that can be attributed with a TSDoc tag such as `@internal`,\r\n * `@alpha`, `@beta`, or `@public`. These \"release tags\" indicate the support level for an API.\r\n *\r\n * @remarks\r\n *\r\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\r\n * API declarations. The non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\r\n * TypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\r\n * features that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\r\n * to extend more than one base class). The \"mixin\" is a TypeScript merged declaration with three components:\r\n * the function that generates a subclass, an interface that describes the members of the subclass, and\r\n * a namespace containing static members of the class.\r\n *\r\n * @public\r\n */\r\n// eslint-disable-next-line @typescript-eslint/naming-convention\r\nexport interface ApiReleaseTagMixin extends ApiItem {\r\n /**\r\n * The effective release tag for this declaration. If it is not explicitly specified, the value may be\r\n * inherited from a containing declaration.\r\n *\r\n * @remarks\r\n * For example, an `ApiEnumMember` may inherit its release tag from the containing `ApiEnum`.\r\n */\r\n readonly releaseTag: ReleaseTag;\r\n\r\n /** @override */\r\n serializeInto(jsonObject: Partial<IApiItemJson>): void;\r\n}\r\n\r\n/**\r\n * Mixin function for {@link (ApiReleaseTagMixin:interface)}.\r\n *\r\n * @param baseClass - The base class to be extended\r\n * @returns A child class that extends baseClass, adding the {@link (ApiReleaseTagMixin:interface)} functionality.\r\n *\r\n * @public\r\n */\r\nexport function ApiReleaseTagMixin<TBaseClass extends IApiItemConstructor>(\r\n baseClass: TBaseClass\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n): TBaseClass & (new (...args: any[]) => ApiReleaseTagMixin) {\r\n abstract class MixedClass extends baseClass implements ApiReleaseTagMixin {\r\n public [_releaseTag]: ReleaseTag;\r\n\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n public constructor(...args: any[]) {\r\n super(...args);\r\n\r\n const options: IApiReleaseTagMixinOptions = args[0];\r\n this[_releaseTag] = options.releaseTag;\r\n }\r\n\r\n /** @override */\r\n public static onDeserializeInto(\r\n options: Partial<IApiReleaseTagMixinOptions>,\r\n context: DeserializerContext,\r\n jsonObject: IApiReleaseTagMixinJson\r\n ): void {\r\n baseClass.onDeserializeInto(options, context, jsonObject);\r\n\r\n const deserializedReleaseTag: ReleaseTag | undefined = Enum.tryGetValueByKey<ReleaseTag>(\r\n ReleaseTag as any, // eslint-disable-line\r\n jsonObject.releaseTag\r\n );\r\n if (deserializedReleaseTag === undefined) {\r\n throw new Error(`Failed to deserialize release tag ${JSON.stringify(jsonObject.releaseTag)}`);\r\n }\r\n\r\n options.releaseTag = deserializedReleaseTag;\r\n }\r\n\r\n public get releaseTag(): ReleaseTag {\r\n return this[_releaseTag];\r\n }\r\n\r\n /** @override */\r\n public serializeInto(jsonObject: Partial<IApiReleaseTagMixinJson>): void {\r\n super.serializeInto(jsonObject);\r\n\r\n jsonObject.releaseTag = ReleaseTag[this.releaseTag];\r\n }\r\n }\r\n\r\n return MixedClass;\r\n}\r\n\r\n/**\r\n * Static members for {@link (ApiReleaseTagMixin:interface)}.\r\n * @public\r\n */\r\nexport namespace ApiReleaseTagMixin {\r\n /**\r\n * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiReleaseTagMixin` mixin.\r\n *\r\n * @remarks\r\n *\r\n * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of\r\n * the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however\r\n * the TypeScript type system cannot invoke a runtime test.)\r\n */\r\n export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiReleaseTagMixin {\r\n return apiItem.hasOwnProperty(_releaseTag);\r\n }\r\n}\r\n"]}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
3
3
|
// See LICENSE in the project root for license information.s
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.ApiReturnTypeMixin = void 0;
|
|
5
6
|
const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem");
|
|
6
7
|
const node_core_library_1 = require("@rushstack/node-core-library");
|
|
7
8
|
const _returnTypeExcerpt = Symbol('ApiReturnTypeMixin._returnTypeExcerpt');
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiReturnTypeMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiReturnTypeMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D
|
|
1
|
+
{"version":3,"file":"ApiReturnTypeMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiReturnTypeMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D;;;AAI5D,8DAA2D;AAC3D,oEAA6D;AAe7D,MAAM,kBAAkB,GAAkB,MAAM,CAAC,uCAAuC,CAAC,CAAC;AA4B1F;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CAChC,SAAqB;AACrB,8DAA8D;;IAE9D,MAAe,UAAW,SAAQ,SAAS;QAGzC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAEf,MAAM,OAAO,GAA+B,IAAI,CAAC,CAAC,CAAC,CAAC;YAEpD,IAAI,IAAI,YAAY,iCAAe,EAAE;gBACnC,IAAI,CAAC,kBAAkB,CAAC,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAC;aAC5E;iBAAM;gBACL,MAAM,IAAI,iCAAa,CAAC,4EAA4E,CAAC,CAAC;aACvG;QACH,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAA4C,EAC5C,OAA4B,EAC5B,UAAmC;YAEnC,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAE1D,OAAO,CAAC,oBAAoB,GAAG,UAAU,CAAC,oBAAoB,CAAC;QACjE,CAAC;QAED,IAAW,iBAAiB;YAC1B,OAAO,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAClC,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAA4C;YAC/D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,UAAU,CAAC,oBAAoB,GAAG,IAAI,CAAC,iBAAiB,CAAC,UAAU,CAAC;QACtE,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AA5CD,gDA4CC;AAED;;;GAGG;AACH,WAAiB,kBAAkB;IACjC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;IACpD,CAAC;IAFe,gCAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAalC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.s\r\n\r\nimport { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';\r\nimport { IExcerptTokenRange, Excerpt } from './Excerpt';\r\nimport { ApiDeclaredItem } from '../items/ApiDeclaredItem';\r\nimport { InternalError } from '@rushstack/node-core-library';\r\nimport { DeserializerContext } from '../model/DeserializerContext';\r\n\r\n/**\r\n * Constructor options for {@link (ApiReturnTypeMixin:interface)}.\r\n * @public\r\n */\r\nexport interface IApiReturnTypeMixinOptions extends IApiItemOptions {\r\n returnTypeTokenRange: IExcerptTokenRange;\r\n}\r\n\r\nexport interface IApiReturnTypeMixinJson extends IApiItemJson {\r\n returnTypeTokenRange: IExcerptTokenRange;\r\n}\r\n\r\nconst _returnTypeExcerpt: unique symbol = Symbol('ApiReturnTypeMixin._returnTypeExcerpt');\r\n\r\n/**\r\n * The mixin base class for API items that are functions that return a value.\r\n *\r\n * @remarks\r\n *\r\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\r\n * API declarations. The non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\r\n * TypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\r\n * features that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\r\n * to extend more than one base class). The \"mixin\" is a TypeScript merged declaration with three components:\r\n * the function that generates a subclass, an interface that describes the members of the subclass, and\r\n * a namespace containing static members of the class.\r\n *\r\n * @public\r\n */\r\n// eslint-disable-next-line @typescript-eslint/naming-convention\r\nexport interface ApiReturnTypeMixin extends ApiItem {\r\n /**\r\n * An {@link Excerpt} that describes the type of the function's return value.\r\n */\r\n readonly returnTypeExcerpt: Excerpt;\r\n\r\n /** @override */\r\n serializeInto(jsonObject: Partial<IApiReturnTypeMixinJson>): void;\r\n}\r\n\r\n/**\r\n * Mixin function for {@link (ApiReturnTypeMixin:interface)}.\r\n *\r\n * @param baseClass - The base class to be extended\r\n * @returns A child class that extends baseClass, adding the {@link (ApiReturnTypeMixin:interface)} functionality.\r\n *\r\n * @public\r\n */\r\nexport function ApiReturnTypeMixin<TBaseClass extends IApiItemConstructor>(\r\n baseClass: TBaseClass\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n): TBaseClass & (new (...args: any[]) => ApiReturnTypeMixin) {\r\n abstract class MixedClass extends baseClass implements ApiReturnTypeMixin {\r\n public [_returnTypeExcerpt]: Excerpt;\r\n\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n public constructor(...args: any[]) {\r\n super(...args);\r\n\r\n const options: IApiReturnTypeMixinOptions = args[0];\r\n\r\n if (this instanceof ApiDeclaredItem) {\r\n this[_returnTypeExcerpt] = this.buildExcerpt(options.returnTypeTokenRange);\r\n } else {\r\n throw new InternalError('ApiReturnTypeMixin expects a base class that inherits from ApiDeclaredItem');\r\n }\r\n }\r\n\r\n /** @override */\r\n public static onDeserializeInto(\r\n options: Partial<IApiReturnTypeMixinOptions>,\r\n context: DeserializerContext,\r\n jsonObject: IApiReturnTypeMixinJson\r\n ): void {\r\n baseClass.onDeserializeInto(options, context, jsonObject);\r\n\r\n options.returnTypeTokenRange = jsonObject.returnTypeTokenRange;\r\n }\r\n\r\n public get returnTypeExcerpt(): Excerpt {\r\n return this[_returnTypeExcerpt];\r\n }\r\n\r\n /** @override */\r\n public serializeInto(jsonObject: Partial<IApiReturnTypeMixinJson>): void {\r\n super.serializeInto(jsonObject);\r\n\r\n jsonObject.returnTypeTokenRange = this.returnTypeExcerpt.tokenRange;\r\n }\r\n }\r\n\r\n return MixedClass;\r\n}\r\n\r\n/**\r\n * Static members for {@link (ApiReturnTypeMixin:interface)}.\r\n * @public\r\n */\r\nexport namespace ApiReturnTypeMixin {\r\n /**\r\n * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiReturnTypeMixin` mixin.\r\n *\r\n * @remarks\r\n *\r\n * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of\r\n * the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however\r\n * the TypeScript type system cannot invoke a runtime test.)\r\n */\r\n export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiReturnTypeMixin {\r\n return apiItem.hasOwnProperty(_returnTypeExcerpt);\r\n }\r\n}\r\n"]}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
3
3
|
// See LICENSE in the project root for license information.s
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.ApiStaticMixin = void 0;
|
|
5
6
|
const _isStatic = Symbol('ApiStaticMixin._isStatic');
|
|
6
7
|
/**
|
|
7
8
|
* Mixin function for {@link (ApiStaticMixin:interface)}.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiStaticMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiStaticMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D
|
|
1
|
+
{"version":3,"file":"ApiStaticMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiStaticMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D;;;AAiB5D,MAAM,SAAS,GAAkB,MAAM,CAAC,0BAA0B,CAAC,CAAC;AA4BpE;;;;;;;GAOG;AACH,SAAgB,cAAc,CAC5B,SAAqB;AACrB,8DAA8D;;IAE9D,MAAe,UAAW,SAAQ,SAAS;QAGzC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAEf,MAAM,OAAO,GAA2B,IAAI,CAAC,CAAC,CAAC,CAAC;YAChD,IAAI,CAAC,SAAS,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;QACrC,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAAwC,EACxC,OAA4B,EAC5B,UAA+B;YAE/B,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAE1D,OAAO,CAAC,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;QACzC,CAAC;QAED,IAAW,QAAQ;YACjB,OAAO,IAAI,CAAC,SAAS,CAAC,CAAC;QACzB,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAAwC;YAC3D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;QACtC,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAvCD,wCAuCC;AAED;;;GAGG;AACH,WAAiB,cAAc;IAC7B;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;IAC3C,CAAC;IAFe,4BAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAa9B","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.s\r\n\r\nimport { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';\r\nimport { DeserializerContext } from '../model/DeserializerContext';\r\n\r\n/**\r\n * Constructor options for {@link (IApiStaticMixinOptions:interface)}.\r\n * @public\r\n */\r\nexport interface IApiStaticMixinOptions extends IApiItemOptions {\r\n isStatic: boolean;\r\n}\r\n\r\nexport interface IApiStaticMixinJson extends IApiItemJson {\r\n isStatic: boolean;\r\n}\r\n\r\nconst _isStatic: unique symbol = Symbol('ApiStaticMixin._isStatic');\r\n\r\n/**\r\n * The mixin base class for API items that can have the TypeScript `static` keyword applied to them.\r\n *\r\n * @remarks\r\n *\r\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\r\n * API declarations. The non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\r\n * TypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\r\n * features that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\r\n * to extend more than one base class). The \"mixin\" is a TypeScript merged declaration with three components:\r\n * the function that generates a subclass, an interface that describes the members of the subclass, and\r\n * a namespace containing static members of the class.\r\n *\r\n * @public\r\n */\r\n// eslint-disable-next-line @typescript-eslint/naming-convention\r\nexport interface ApiStaticMixin extends ApiItem {\r\n /**\r\n * Whether the declaration has the TypeScript `static` keyword.\r\n */\r\n readonly isStatic: boolean;\r\n\r\n /** @override */\r\n serializeInto(jsonObject: Partial<IApiItemJson>): void;\r\n}\r\n\r\n/**\r\n * Mixin function for {@link (ApiStaticMixin:interface)}.\r\n *\r\n * @param baseClass - The base class to be extended\r\n * @returns A child class that extends baseClass, adding the {@link (ApiStaticMixin:interface)} functionality.\r\n *\r\n * @public\r\n */\r\nexport function ApiStaticMixin<TBaseClass extends IApiItemConstructor>(\r\n baseClass: TBaseClass\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n): TBaseClass & (new (...args: any[]) => ApiStaticMixin) {\r\n abstract class MixedClass extends baseClass implements ApiStaticMixin {\r\n public [_isStatic]: boolean;\r\n\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n public constructor(...args: any[]) {\r\n super(...args);\r\n\r\n const options: IApiStaticMixinOptions = args[0];\r\n this[_isStatic] = options.isStatic;\r\n }\r\n\r\n /** @override */\r\n public static onDeserializeInto(\r\n options: Partial<IApiStaticMixinOptions>,\r\n context: DeserializerContext,\r\n jsonObject: IApiStaticMixinJson\r\n ): void {\r\n baseClass.onDeserializeInto(options, context, jsonObject);\r\n\r\n options.isStatic = jsonObject.isStatic;\r\n }\r\n\r\n public get isStatic(): boolean {\r\n return this[_isStatic];\r\n }\r\n\r\n /** @override */\r\n public serializeInto(jsonObject: Partial<IApiStaticMixinJson>): void {\r\n super.serializeInto(jsonObject);\r\n\r\n jsonObject.isStatic = this.isStatic;\r\n }\r\n }\r\n\r\n return MixedClass;\r\n}\r\n\r\n/**\r\n * Static members for {@link (ApiStaticMixin:interface)}.\r\n * @public\r\n */\r\nexport namespace ApiStaticMixin {\r\n /**\r\n * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiStaticMixin` mixin.\r\n *\r\n * @remarks\r\n *\r\n * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of\r\n * the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however\r\n * the TypeScript type system cannot invoke a runtime test.)\r\n */\r\n export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiStaticMixin {\r\n return apiItem.hasOwnProperty(_isStatic);\r\n }\r\n}\r\n"]}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
3
3
|
// See LICENSE in the project root for license information.s
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.ApiTypeParameterListMixin = void 0;
|
|
5
6
|
const TypeParameter_1 = require("../model/TypeParameter");
|
|
6
7
|
const node_core_library_1 = require("@rushstack/node-core-library");
|
|
7
8
|
const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiTypeParameterListMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiTypeParameterListMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D
|
|
1
|
+
{"version":3,"file":"ApiTypeParameterListMixin.js","sourceRoot":"","sources":["../../src/mixins/ApiTypeParameterListMixin.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,4DAA4D;;;AAI5D,0DAAuD;AACvD,oEAA6D;AAC7D,8DAA2D;AAyB3D,MAAM,eAAe,GAAkB,MAAM,CAAC,2CAA2C,CAAC,CAAC;AA2B3F;;;;;;;;GAQG;AACH,SAAgB,yBAAyB,CACvC,SAAqB;AACrB,8DAA8D;;IAE9D,MAAe,UAAW,SAAQ,SAAS;QAGzC,8DAA8D;QAC9D,YAAmB,GAAG,IAAW;YAC/B,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;YAEf,MAAM,OAAO,GAAsC,IAAI,CAAC,CAAC,CAAC,CAAC;YAE3D,IAAI,CAAC,eAAe,CAAC,GAAG,EAAE,CAAC;YAE3B,IAAI,IAAI,YAAY,iCAAe,EAAE;gBACnC,IAAI,OAAO,CAAC,cAAc,EAAE;oBAC1B,KAAK,MAAM,oBAAoB,IAAI,OAAO,CAAC,cAAc,EAAE;wBACzD,MAAM,aAAa,GAAkB,IAAI,6BAAa,CAAC;4BACrD,IAAI,EAAE,oBAAoB,CAAC,iBAAiB;4BAC5C,iBAAiB,EAAE,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,oBAAoB,CAAC;4BAC/E,kBAAkB,EAAE,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,qBAAqB,CAAC;4BACjF,MAAM,EAAE,IAAI;yBACb,CAAC,CAAC;wBAEH,IAAI,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;qBAC3C;iBACF;aACF;iBAAM;gBACL,MAAM,IAAI,iCAAa,CACrB,mFAAmF,CACpF,CAAC;aACH;QACH,CAAC;QAED,gBAAgB;QACT,MAAM,CAAC,iBAAiB,CAC7B,OAAmD,EACnD,OAA4B,EAC5B,UAA0C;YAE1C,SAAS,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;YAE1D,OAAO,CAAC,cAAc,GAAG,UAAU,CAAC,cAAc,IAAI,EAAE,CAAC;QAC3D,CAAC;QAED,IAAW,cAAc;YACvB,OAAO,IAAI,CAAC,eAAe,CAAC,CAAC;QAC/B,CAAC;QAED,gBAAgB;QACT,aAAa,CAAC,UAAmD;YACtE,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;YAEhC,MAAM,oBAAoB,GAA+B,EAAE,CAAC;YAC5D,KAAK,MAAM,aAAa,IAAI,IAAI,CAAC,cAAc,EAAE;gBAC/C,oBAAoB,CAAC,IAAI,CAAC;oBACxB,iBAAiB,EAAE,aAAa,CAAC,IAAI;oBACrC,oBAAoB,EAAE,aAAa,CAAC,iBAAiB,CAAC,UAAU;oBAChE,qBAAqB,EAAE,aAAa,CAAC,kBAAkB,CAAC,UAAU;iBACnE,CAAC,CAAC;aACJ;YAED,IAAI,oBAAoB,CAAC,MAAM,GAAG,CAAC,EAAE;gBACnC,UAAU,CAAC,cAAc,GAAG,oBAAoB,CAAC;aAClD;QACH,CAAC;KACF;IAED,OAAO,UAAU,CAAC;AACpB,CAAC;AAtED,8DAsEC;AAED;;;GAGG;AACH,WAAiB,yBAAyB;IACxC;;;;;;;;OAQG;IACH,SAAgB,aAAa,CAAC,OAAgB;QAC5C,OAAO,OAAO,CAAC,cAAc,CAAC,eAAe,CAAC,CAAC;IACjD,CAAC;IAFe,uCAAa,gBAE5B,CAAA;AACH,CAAC,EAbgB,yBAAyB,GAAzB,iCAAyB,KAAzB,iCAAyB,QAazC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.s\r\n\r\nimport { ApiItem, IApiItemJson, IApiItemConstructor, IApiItemOptions } from '../items/ApiItem';\r\nimport { IExcerptTokenRange } from './Excerpt';\r\nimport { TypeParameter } from '../model/TypeParameter';\r\nimport { InternalError } from '@rushstack/node-core-library';\r\nimport { ApiDeclaredItem } from '../items/ApiDeclaredItem';\r\nimport { DeserializerContext } from '../model/DeserializerContext';\r\n\r\n/**\r\n * Represents parameter information that is part of {@link IApiTypeParameterListMixinOptions}\r\n * @public\r\n */\r\nexport interface IApiTypeParameterOptions {\r\n typeParameterName: string;\r\n constraintTokenRange: IExcerptTokenRange;\r\n defaultTypeTokenRange: IExcerptTokenRange;\r\n}\r\n\r\n/**\r\n * Constructor options for {@link (ApiTypeParameterListMixin:interface)}.\r\n * @public\r\n */\r\nexport interface IApiTypeParameterListMixinOptions extends IApiItemOptions {\r\n typeParameters: IApiTypeParameterOptions[];\r\n}\r\n\r\nexport interface IApiTypeParameterListMixinJson extends IApiItemJson {\r\n typeParameters: IApiTypeParameterOptions[];\r\n}\r\n\r\nconst _typeParameters: unique symbol = Symbol('ApiTypeParameterListMixin._typeParameters');\r\n\r\n/**\r\n * The mixin base class for API items that can have type parameters.\r\n *\r\n * @remarks\r\n *\r\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\r\n * API declarations. The non-abstract classes (e.g. `ApiClass`, `ApiEnum`, `ApiInterface`, etc.) use\r\n * TypeScript \"mixin\" functions (e.g. `ApiDeclaredItem`, `ApiItemContainerMixin`, etc.) to add various\r\n * features that cannot be represented as a normal inheritance chain (since TypeScript does not allow a child class\r\n * to extend more than one base class). The \"mixin\" is a TypeScript merged declaration with three components:\r\n * the function that generates a subclass, an interface that describes the members of the subclass, and\r\n * a namespace containing static members of the class.\r\n *\r\n * @public\r\n */\r\n// eslint-disable-next-line @typescript-eslint/naming-convention\r\nexport interface ApiTypeParameterListMixin extends ApiItem {\r\n /**\r\n * The type parameters.\r\n */\r\n readonly typeParameters: ReadonlyArray<TypeParameter>;\r\n\r\n serializeInto(jsonObject: Partial<IApiItemJson>): void;\r\n}\r\n\r\n/**\r\n * Mixin function for {@link (ApiTypeParameterListMixin:interface)}.\r\n *\r\n * @param baseClass - The base class to be extended\r\n * @returns A child class that extends baseClass, adding the {@link (ApiTypeParameterListMixin:interface)}\r\n * functionality.\r\n *\r\n * @public\r\n */\r\nexport function ApiTypeParameterListMixin<TBaseClass extends IApiItemConstructor>(\r\n baseClass: TBaseClass\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n): TBaseClass & (new (...args: any[]) => ApiTypeParameterListMixin) {\r\n abstract class MixedClass extends baseClass implements ApiTypeParameterListMixin {\r\n public readonly [_typeParameters]: TypeParameter[];\r\n\r\n // eslint-disable-next-line @typescript-eslint/no-explicit-any\r\n public constructor(...args: any[]) {\r\n super(...args);\r\n\r\n const options: IApiTypeParameterListMixinOptions = args[0];\r\n\r\n this[_typeParameters] = [];\r\n\r\n if (this instanceof ApiDeclaredItem) {\r\n if (options.typeParameters) {\r\n for (const typeParameterOptions of options.typeParameters) {\r\n const typeParameter: TypeParameter = new TypeParameter({\r\n name: typeParameterOptions.typeParameterName,\r\n constraintExcerpt: this.buildExcerpt(typeParameterOptions.constraintTokenRange),\r\n defaultTypeExcerpt: this.buildExcerpt(typeParameterOptions.defaultTypeTokenRange),\r\n parent: this\r\n });\r\n\r\n this[_typeParameters].push(typeParameter);\r\n }\r\n }\r\n } else {\r\n throw new InternalError(\r\n 'ApiTypeParameterListMixin expects a base class that inherits from ApiDeclaredItem'\r\n );\r\n }\r\n }\r\n\r\n /** @override */\r\n public static onDeserializeInto(\r\n options: Partial<IApiTypeParameterListMixinOptions>,\r\n context: DeserializerContext,\r\n jsonObject: IApiTypeParameterListMixinJson\r\n ): void {\r\n baseClass.onDeserializeInto(options, context, jsonObject);\r\n\r\n options.typeParameters = jsonObject.typeParameters || [];\r\n }\r\n\r\n public get typeParameters(): ReadonlyArray<TypeParameter> {\r\n return this[_typeParameters];\r\n }\r\n\r\n /** @override */\r\n public serializeInto(jsonObject: Partial<IApiTypeParameterListMixinJson>): void {\r\n super.serializeInto(jsonObject);\r\n\r\n const typeParameterObjects: IApiTypeParameterOptions[] = [];\r\n for (const typeParameter of this.typeParameters) {\r\n typeParameterObjects.push({\r\n typeParameterName: typeParameter.name,\r\n constraintTokenRange: typeParameter.constraintExcerpt.tokenRange,\r\n defaultTypeTokenRange: typeParameter.defaultTypeExcerpt.tokenRange\r\n });\r\n }\r\n\r\n if (typeParameterObjects.length > 0) {\r\n jsonObject.typeParameters = typeParameterObjects;\r\n }\r\n }\r\n }\r\n\r\n return MixedClass;\r\n}\r\n\r\n/**\r\n * Static members for {@link (ApiTypeParameterListMixin:interface)}.\r\n * @public\r\n */\r\nexport namespace ApiTypeParameterListMixin {\r\n /**\r\n * A type guard that tests whether the specified `ApiItem` subclass extends the `ApiParameterListMixin` mixin.\r\n *\r\n * @remarks\r\n *\r\n * The JavaScript `instanceof` operator cannot be used to test for mixin inheritance, because each invocation of\r\n * the mixin function produces a different subclass. (This could be mitigated by `Symbol.hasInstance`, however\r\n * the TypeScript type system cannot invoke a runtime test.)\r\n */\r\n export function isBaseClassOf(apiItem: ApiItem): apiItem is ApiTypeParameterListMixin {\r\n return apiItem.hasOwnProperty(_typeParameters);\r\n }\r\n}\r\n"]}
|
package/lib/mixins/Excerpt.d.ts
CHANGED
|
@@ -48,16 +48,16 @@ export declare class ExcerptToken {
|
|
|
48
48
|
/**
|
|
49
49
|
* Indicates the kind of token.
|
|
50
50
|
*/
|
|
51
|
-
|
|
51
|
+
get kind(): ExcerptTokenKind;
|
|
52
52
|
/**
|
|
53
53
|
* The text fragment.
|
|
54
54
|
*/
|
|
55
|
-
|
|
55
|
+
get text(): string;
|
|
56
56
|
/**
|
|
57
57
|
* The hyperlink target for a token whose type is `ExcerptTokenKind.Reference`. For other token types,
|
|
58
58
|
* this property will be `undefined`.
|
|
59
59
|
*/
|
|
60
|
-
|
|
60
|
+
get canonicalReference(): DeclarationReference | undefined;
|
|
61
61
|
}
|
|
62
62
|
/**
|
|
63
63
|
* The `Excerpt` class is used by {@link ApiDeclaredItem} to represent a TypeScript code fragment that may be
|
|
@@ -104,10 +104,10 @@ export declare class Excerpt {
|
|
|
104
104
|
/**
|
|
105
105
|
* The excerpted text, formed by concatenating the text of the `spannedTokens` strings.
|
|
106
106
|
*/
|
|
107
|
-
|
|
107
|
+
get text(): string;
|
|
108
108
|
/**
|
|
109
109
|
* Returns true if the excerpt is an empty range.
|
|
110
110
|
*/
|
|
111
|
-
|
|
111
|
+
get isEmpty(): boolean;
|
|
112
112
|
}
|
|
113
113
|
//# sourceMappingURL=Excerpt.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Excerpt.d.ts","sourceRoot":"","sources":["../../src/mixins/Excerpt.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gDAAgD,CAAC;AAGtF,cAAc;AACd,0BAAkB,gBAAgB;IAChC;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,SAAS,cAAc;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,cAAc;AACd,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;GAIG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAmB;IACzC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAmC;gBAEpD,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,oBAAoB;IAUlG;;OAEG;
|
|
1
|
+
{"version":3,"file":"Excerpt.d.ts","sourceRoot":"","sources":["../../src/mixins/Excerpt.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gDAAgD,CAAC;AAGtF,cAAc;AACd,0BAAkB,gBAAgB;IAChC;;OAEG;IACH,OAAO,YAAY;IAEnB;;OAEG;IACH,SAAS,cAAc;CACxB;AAED;;;;GAIG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;;;;OAMG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,cAAc;AACd,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED;;;;GAIG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAmB;IACzC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAmC;gBAEpD,IAAI,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,EAAE,kBAAkB,CAAC,EAAE,oBAAoB;IAUlG;;OAEG;IACH,IAAW,IAAI,IAAI,gBAAgB,CAElC;IAED;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;;OAGG;IACH,IAAW,kBAAkB,IAAI,oBAAoB,GAAG,SAAS,CAEhE;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,qBAAa,OAAO;IAClB;;;;OAIG;IACH,SAAgB,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IAEpD;;OAEG;IACH,SAAgB,UAAU,EAAE,QAAQ,CAAC,kBAAkB,CAAC,CAAC;IAEzD;;;OAGG;IACH,SAAgB,aAAa,EAAE,aAAa,CAAC,YAAY,CAAC,CAAC;IAE3D,OAAO,CAAC,KAAK,CAAqB;gBAEf,MAAM,EAAE,aAAa,CAAC,YAAY,CAAC,EAAE,UAAU,EAAE,kBAAkB;IAetF;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAKxB;IAED;;OAEG;IACH,IAAW,OAAO,IAAI,OAAO,CAE5B;CACF"}
|
package/lib/mixins/Excerpt.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
3
3
|
// See LICENSE in the project root for license information.
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.Excerpt = exports.ExcerptToken = void 0;
|
|
5
6
|
const node_core_library_1 = require("@rushstack/node-core-library");
|
|
6
7
|
/**
|
|
7
8
|
* Represents a fragment of text belonging to an {@link Excerpt} object.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Excerpt.js","sourceRoot":"","sources":["../../src/mixins/Excerpt.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D
|
|
1
|
+
{"version":3,"file":"Excerpt.js","sourceRoot":"","sources":["../../src/mixins/Excerpt.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAG3D,oEAAoD;AA2CpD;;;;GAIG;AACH,MAAa,YAAY;IAKvB,YAAmB,IAAsB,EAAE,IAAY,EAAE,kBAAyC;QAChG,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAElB,kGAAkG;QAClG,4FAA4F;QAC5F,kFAAkF;QAClF,IAAI,CAAC,KAAK,GAAG,wBAAI,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,CAAC,mBAAmB,GAAG,kBAAkB,CAAC;IAChD,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;;OAGG;IACH,IAAW,kBAAkB;QAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC;IAClC,CAAC;CACF;AApCD,oCAoCC;AAED;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAa,OAAO;IAqBlB,YAAmB,MAAmC,EAAE,UAA8B;QACpF,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE7B,IACE,IAAI,CAAC,UAAU,CAAC,UAAU,GAAG,CAAC;YAC9B,IAAI,CAAC,UAAU,CAAC,QAAQ,GAAG,IAAI,CAAC,MAAM,CAAC,MAAM;YAC7C,IAAI,CAAC,UAAU,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,QAAQ,EACrD;YACA,MAAM,IAAI,KAAK,CAAC,qBAAqB,CAAC,CAAC;SACxC;QAED,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;IAC/F,CAAC;IAED;;OAEG;IACH,IAAW,IAAI;QACb,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE;YAC5B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SAC7D;QACD,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,UAAU,CAAC,UAAU,KAAK,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;IACjE,CAAC;CACF;AApDD,0BAoDC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { DeclarationReference } from '@microsoft/tsdoc/lib/beta/DeclarationReference';\r\nimport { Text } from '@rushstack/node-core-library';\r\n\r\n/** @public */\r\nexport const enum ExcerptTokenKind {\r\n /**\r\n * Generic text without any special properties\r\n */\r\n Content = 'Content',\r\n\r\n /**\r\n * A reference to an API declaration\r\n */\r\n Reference = 'Reference'\r\n}\r\n\r\n/**\r\n * Used by {@link Excerpt} to indicate a range of indexes within an array of `ExcerptToken` objects.\r\n *\r\n * @public\r\n */\r\nexport interface IExcerptTokenRange {\r\n /**\r\n * The starting index of the span.\r\n */\r\n startIndex: number;\r\n\r\n /**\r\n * The index of the last member of the span, plus one.\r\n *\r\n * @remarks\r\n *\r\n * If `startIndex` and `endIndex` are the same number, then the span is empty.\r\n */\r\n endIndex: number;\r\n}\r\n\r\n/** @public */\r\nexport interface IExcerptToken {\r\n readonly kind: ExcerptTokenKind;\r\n text: string;\r\n canonicalReference?: string;\r\n}\r\n\r\n/**\r\n * Represents a fragment of text belonging to an {@link Excerpt} object.\r\n *\r\n * @public\r\n */\r\nexport class ExcerptToken {\r\n private readonly _kind: ExcerptTokenKind;\r\n private readonly _text: string;\r\n private readonly _canonicalReference: DeclarationReference | undefined;\r\n\r\n public constructor(kind: ExcerptTokenKind, text: string, canonicalReference?: DeclarationReference) {\r\n this._kind = kind;\r\n\r\n // Standardize the newlines across operating systems. Even though this may deviate from the actual\r\n // input source file that was parsed, it's useful because the newline gets serialized inside\r\n // a string literal in .api.json, which cannot be automatically normalized by Git.\r\n this._text = Text.convertToLf(text);\r\n this._canonicalReference = canonicalReference;\r\n }\r\n\r\n /**\r\n * Indicates the kind of token.\r\n */\r\n public get kind(): ExcerptTokenKind {\r\n return this._kind;\r\n }\r\n\r\n /**\r\n * The text fragment.\r\n */\r\n public get text(): string {\r\n return this._text;\r\n }\r\n\r\n /**\r\n * The hyperlink target for a token whose type is `ExcerptTokenKind.Reference`. For other token types,\r\n * this property will be `undefined`.\r\n */\r\n public get canonicalReference(): DeclarationReference | undefined {\r\n return this._canonicalReference;\r\n }\r\n}\r\n\r\n/**\r\n * The `Excerpt` class is used by {@link ApiDeclaredItem} to represent a TypeScript code fragment that may be\r\n * annotated with hyperlinks to declared types (and in the future, source code locations).\r\n *\r\n * @remarks\r\n * API Extractor's .api.json file format stores excerpts compactly as a start/end indexes into an array of tokens.\r\n * Every `ApiDeclaredItem` has a \"main excerpt\" corresponding to the full list of tokens. The declaration may\r\n * also have have \"captured\" excerpts that correspond to subranges of tokens.\r\n *\r\n * For example, if the main excerpt is:\r\n *\r\n * ```\r\n * function parse(s: string): Vector | undefined;\r\n * ```\r\n *\r\n * ...then this entire signature is the \"main excerpt\", whereas the function's return type `Vector | undefined` is a\r\n * captured excerpt. The `Vector` token might be a hyperlink to that API item.\r\n *\r\n * An excerpt may be empty (i.e. a token range containing zero tokens). For example, if a function's return value\r\n * is not explicitly declared, then the returnTypeExcerpt will be empty. By contrast, a class constructor cannot\r\n * have a return value, so ApiConstructor has no returnTypeExcerpt property at all.\r\n *\r\n * @public\r\n */\r\nexport class Excerpt {\r\n /**\r\n * The complete list of tokens for the source code fragment that this excerpt is based upon.\r\n * If this object is the main excerpt, then it will span all of the tokens; otherwise, it will correspond to\r\n * a range within the array.\r\n */\r\n public readonly tokens: ReadonlyArray<ExcerptToken>;\r\n\r\n /**\r\n * Specifies the excerpt's range within the `tokens` array.\r\n */\r\n public readonly tokenRange: Readonly<IExcerptTokenRange>;\r\n\r\n /**\r\n * The tokens spanned by this excerpt. It is the range of the `tokens` array as specified by the `tokenRange`\r\n * property.\r\n */\r\n public readonly spannedTokens: ReadonlyArray<ExcerptToken>;\r\n\r\n private _text: string | undefined;\r\n\r\n public constructor(tokens: ReadonlyArray<ExcerptToken>, tokenRange: IExcerptTokenRange) {\r\n this.tokens = tokens;\r\n this.tokenRange = tokenRange;\r\n\r\n if (\r\n this.tokenRange.startIndex < 0 ||\r\n this.tokenRange.endIndex > this.tokens.length ||\r\n this.tokenRange.startIndex > this.tokenRange.endIndex\r\n ) {\r\n throw new Error('Invalid token range');\r\n }\r\n\r\n this.spannedTokens = this.tokens.slice(this.tokenRange.startIndex, this.tokenRange.endIndex);\r\n }\r\n\r\n /**\r\n * The excerpted text, formed by concatenating the text of the `spannedTokens` strings.\r\n */\r\n public get text(): string {\r\n if (this._text === undefined) {\r\n this._text = this.spannedTokens.map((x) => x.text).join('');\r\n }\r\n return this._text;\r\n }\r\n\r\n /**\r\n * Returns true if the excerpt is an empty range.\r\n */\r\n public get isEmpty(): boolean {\r\n return this.tokenRange.startIndex === this.tokenRange.endIndex;\r\n }\r\n}\r\n"]}
|
|
@@ -45,9 +45,9 @@ export declare class ApiCallSignature extends ApiCallSignature_base {
|
|
|
45
45
|
constructor(options: IApiCallSignatureOptions);
|
|
46
46
|
static getContainerKey(overloadIndex: number): string;
|
|
47
47
|
/** @override */
|
|
48
|
-
|
|
48
|
+
get kind(): ApiItemKind;
|
|
49
49
|
/** @override */
|
|
50
|
-
|
|
50
|
+
get containerKey(): string;
|
|
51
51
|
/** @beta @override */
|
|
52
52
|
buildCanonicalReference(): DeclarationReference;
|
|
53
53
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiCallSignature.d.ts","sourceRoot":"","sources":["../../src/model/ApiCallSignature.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAuB,MAAM,gDAAgD,CAAC;AAC3G,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EACL,iCAAiC,EACjC,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,wBACf,SAAQ,iCAAiC,EACvC,6BAA6B,EAC7B,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,gBAAiB,SAAQ,qBAErC;gBACoB,OAAO,EAAE,wBAAwB;WAItC,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAI5D,gBAAgB;
|
|
1
|
+
{"version":3,"file":"ApiCallSignature.d.ts","sourceRoot":"","sources":["../../src/model/ApiCallSignature.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAuB,MAAM,gDAAgD,CAAC;AAC3G,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EACL,iCAAiC,EACjC,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,wBACf,SAAQ,iCAAiC,EACvC,6BAA6B,EAC7B,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,qBAAa,gBAAiB,SAAQ,qBAErC;gBACoB,OAAO,EAAE,wBAAwB;WAItC,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAI5D,gBAAgB;IAChB,IAAW,IAAI,IAAI,WAAW,CAE7B;IAED,gBAAgB;IAChB,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAOvD"}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
3
3
|
// See LICENSE in the project root for license information.
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.ApiCallSignature = void 0;
|
|
5
6
|
const DeclarationReference_1 = require("@microsoft/tsdoc/lib/beta/DeclarationReference");
|
|
6
7
|
const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem");
|
|
7
8
|
const ApiParameterListMixin_1 = require("../mixins/ApiParameterListMixin");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiCallSignature.js","sourceRoot":"","sources":["../../src/model/ApiCallSignature.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D
|
|
1
|
+
{"version":3,"file":"ApiCallSignature.js","sourceRoot":"","sources":["../../src/model/ApiCallSignature.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAA2G;AAE3G,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAC9F,qEAA8F;AAC9F,mFAG6C;AAa7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,MAAa,gBAAiB,SAAQ,qDAAyB,CAC7D,6CAAqB,CAAC,uCAAkB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CAAC,CAC/E;IACC,YAAmB,OAAiC;QAClD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,aAAqB;QACjD,OAAO,IAAI,mCAAyB,IAAI,aAAa,EAAE,CAAC;IAC1D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,2CAAiC;IACnC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,gBAAgB,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC9D,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,MAAM,GAAyB,IAAI,CAAC,MAAM;YAC9C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB;YAChC,CAAC,CAAC,iDAAiD;gBACjD,2CAAoB,CAAC,KAAK,EAAE,CAAC,iBAAiB,oBAAqB,UAAU,CAAC,CAAC;QACnF,OAAO,MAAM,CAAC,WAAW,4BAAuB,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACzF,CAAC;CACF;AA7BD,4CA6BC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference';\r\nimport { ApiItemKind } from '../items/ApiItem';\r\nimport { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem';\r\nimport { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\r\nimport { IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';\r\nimport { IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';\r\nimport {\r\n IApiTypeParameterListMixinOptions,\r\n ApiTypeParameterListMixin\r\n} from '../mixins/ApiTypeParameterListMixin';\r\n\r\n/**\r\n * Constructor options for {@link ApiCallSignature}.\r\n * @public\r\n */\r\nexport interface IApiCallSignatureOptions\r\n extends IApiTypeParameterListMixinOptions,\r\n IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiReturnTypeMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript function call signature.\r\n *\r\n * @remarks\r\n *\r\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\r\n * API declarations.\r\n *\r\n * `ApiCallSignature` represents a TypeScript declaration such as `(x: number, y: number): number`\r\n * in this example:\r\n *\r\n * ```ts\r\n * export interface IChooser {\r\n * // A call signature:\r\n * (x: number, y: number): number;\r\n *\r\n * // Another overload for this call signature:\r\n * (x: string, y: string): string;\r\n * }\r\n *\r\n * function chooseFirst<T>(x: T, y: T): T {\r\n * return x;\r\n * }\r\n *\r\n * let chooser: IChooser = chooseFirst;\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class ApiCallSignature extends ApiTypeParameterListMixin(\r\n ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem)))\r\n) {\r\n public constructor(options: IApiCallSignatureOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(overloadIndex: number): string {\r\n return `|${ApiItemKind.CallSignature}|${overloadIndex}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.CallSignature;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiCallSignature.getContainerKey(this.overloadIndex);\r\n }\r\n\r\n /** @beta @override */\r\n public buildCanonicalReference(): DeclarationReference {\r\n const parent: DeclarationReference = this.parent\r\n ? this.parent.canonicalReference\r\n : // .withMeaning() requires some kind of component\r\n DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)');\r\n return parent.withMeaning(Meaning.CallSignature).withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
|
package/lib/model/ApiClass.d.ts
CHANGED
|
@@ -48,13 +48,13 @@ export declare class ApiClass extends ApiClass_base {
|
|
|
48
48
|
/** @override */
|
|
49
49
|
static onDeserializeInto(options: Partial<IApiClassOptions>, context: DeserializerContext, jsonObject: IApiClassJson): void;
|
|
50
50
|
/** @override */
|
|
51
|
-
|
|
51
|
+
get kind(): ApiItemKind;
|
|
52
52
|
/** @override */
|
|
53
|
-
|
|
53
|
+
get containerKey(): string;
|
|
54
54
|
/**
|
|
55
55
|
* The list of interfaces that this class implements using the `implements` keyword.
|
|
56
56
|
*/
|
|
57
|
-
|
|
57
|
+
get implementsTypes(): ReadonlyArray<HeritageType>;
|
|
58
58
|
/** @override */
|
|
59
59
|
serializeInto(jsonObject: Partial<IApiClassJson>): void;
|
|
60
60
|
/** @beta @override */
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiClass.d.ts","sourceRoot":"","sources":["../../src/model/ApiClass.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,oBAAoB,EAIrB,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAC1G,OAAO,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EACL,yBAAyB,EACzB,iCAAiC,EACjC,8BAA8B,EAC/B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,gBACf,SAAQ,6BAA6B,EACnC,oBAAoB,EACpB,0BAA0B,EAC1B,uBAAuB,EACvB,iCAAiC;IACnC,iBAAiB,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAClD,qBAAqB,EAAE,kBAAkB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,aAAc,SAAQ,oBAAoB,EAAE,8BAA8B;IACzF,iBAAiB,CAAC,EAAE,kBAAkB,CAAC;IACvC,qBAAqB,EAAE,kBAAkB,EAAE,CAAC;CAC7C;;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,QAAS,SAAQ,aAE7B;IACC;;OAEG;IACH,SAAgB,WAAW,EAAE,YAAY,GAAG,SAAS,CAAC;IAEtD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAsB;gBAEpC,OAAO,EAAE,gBAAgB;WAc9B,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAInD,gBAAgB;WACF,iBAAiB,CAC7B,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAClC,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,aAAa,GACxB,IAAI;IAOP,gBAAgB;
|
|
1
|
+
{"version":3,"file":"ApiClass.d.ts","sourceRoot":"","sources":["../../src/model/ApiClass.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,oBAAoB,EAIrB,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAC1G,OAAO,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EACL,yBAAyB,EACzB,iCAAiC,EACjC,8BAA8B,EAC/B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,gBACf,SAAQ,6BAA6B,EACnC,oBAAoB,EACpB,0BAA0B,EAC1B,uBAAuB,EACvB,iCAAiC;IACnC,iBAAiB,EAAE,kBAAkB,GAAG,SAAS,CAAC;IAClD,qBAAqB,EAAE,kBAAkB,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,aAAc,SAAQ,oBAAoB,EAAE,8BAA8B;IACzF,iBAAiB,CAAC,EAAE,kBAAkB,CAAC;IACvC,qBAAqB,EAAE,kBAAkB,EAAE,CAAC;CAC7C;;AAED;;;;;;;;;;;;;;;GAeG;AACH,qBAAa,QAAS,SAAQ,aAE7B;IACC;;OAEG;IACH,SAAgB,WAAW,EAAE,YAAY,GAAG,SAAS,CAAC;IAEtD,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAsB;gBAEpC,OAAO,EAAE,gBAAgB;WAc9B,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAInD,gBAAgB;WACF,iBAAiB,CAC7B,OAAO,EAAE,OAAO,CAAC,gBAAgB,CAAC,EAClC,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,aAAa,GACxB,IAAI;IAOP,gBAAgB;IAChB,IAAW,IAAI,IAAI,WAAW,CAE7B;IAED,gBAAgB;IAChB,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAW,eAAe,IAAI,aAAa,CAAC,YAAY,CAAC,CAExD;IAED,gBAAgB;IACT,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI;IAW9D,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAMvD"}
|
package/lib/model/ApiClass.js
CHANGED
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
3
3
|
// See LICENSE in the project root for license information.
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.ApiClass = void 0;
|
|
5
6
|
const DeclarationReference_1 = require("@microsoft/tsdoc/lib/beta/DeclarationReference");
|
|
6
7
|
const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem");
|
|
7
8
|
const ApiItemContainerMixin_1 = require("../mixins/ApiItemContainerMixin");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiClass.js","sourceRoot":"","sources":["../../src/model/ApiClass.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D
|
|
1
|
+
{"version":3,"file":"ApiClass.js","sourceRoot":"","sources":["../../src/model/ApiClass.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAKwD;AAExD,8DAA0G;AAC1G,2EAAuG;AACvG,qEAA8F;AAE9F,iDAA8C;AAC9C,yDAA4E;AAC5E,mFAI6C;AAsB7C;;;;;;;;;;;;;;;GAeG;AACH,MAAa,QAAS,SAAQ,6CAAqB,CACjD,2BAAY,CAAC,qDAAyB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CAAC,CAC7E;IAQC,YAAmB,OAAyB;QAC1C,KAAK,CAAC,OAAO,CAAC,CAAC;QAHA,qBAAgB,GAAmB,EAAE,CAAC;QAKrD,IAAI,OAAO,CAAC,iBAAiB,EAAE;YAC7B,IAAI,CAAC,WAAW,GAAG,IAAI,2BAAY,CAAC,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC;SACnF;aAAM;YACL,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;SAC9B;QAED,KAAK,MAAM,oBAAoB,IAAI,OAAO,CAAC,qBAAqB,EAAE;YAChE,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,IAAI,2BAAY,CAAC,IAAI,CAAC,YAAY,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC;SACvF;IACH,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,mBAAiB,EAAE,CAAC;IACxC,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAAkC,EAClC,OAA4B,EAC5B,UAAyB;QAEzB,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,OAAO,CAAC,iBAAiB,GAAG,UAAU,CAAC,iBAAiB,CAAC;QACzD,OAAO,CAAC,qBAAqB,GAAG,UAAU,CAAC,qBAAqB,CAAC;IACnE,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,2BAAyB;IAC3B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACxB,OAAO,IAAI,CAAC,gBAAgB,CAAC;IAC/B,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,UAAkC;QACrD,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEhC,iHAAiH;QACjH,IAAI,IAAI,CAAC,WAAW,EAAE;YACpB,UAAU,CAAC,iBAAiB,GAAG,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC;SACpE;QAED,UAAU,CAAC,qBAAqB,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3F,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,aAAa,GAAc,2CAAoB,CAAC,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB,CAAC,CAAC,CAAC,2CAAoB,CAAC,KAAK,EAAE,CAAC;aACjF,iBAAiB,oBAAqB,aAAa,CAAC;aACpD,WAAW,qBAAe,CAAC;IAChC,CAAC;CACF;AA5ED,4BA4EC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport {\r\n DeclarationReference,\r\n Meaning,\r\n Navigation,\r\n Component\r\n} from '@microsoft/tsdoc/lib/beta/DeclarationReference';\r\nimport { ApiItemKind } from '../items/ApiItem';\r\nimport { ApiDeclaredItem, IApiDeclaredItemOptions, IApiDeclaredItemJson } from '../items/ApiDeclaredItem';\r\nimport { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin';\r\nimport { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\r\nimport { IExcerptTokenRange } from '../mixins/Excerpt';\r\nimport { HeritageType } from './HeritageType';\r\nimport { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\nimport {\r\n ApiTypeParameterListMixin,\r\n IApiTypeParameterListMixinOptions,\r\n IApiTypeParameterListMixinJson\r\n} from '../mixins/ApiTypeParameterListMixin';\r\nimport { DeserializerContext } from './DeserializerContext';\r\n\r\n/**\r\n * Constructor options for {@link ApiClass}.\r\n * @public\r\n */\r\nexport interface IApiClassOptions\r\n extends IApiItemContainerMixinOptions,\r\n IApiNameMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiDeclaredItemOptions,\r\n IApiTypeParameterListMixinOptions {\r\n extendsTokenRange: IExcerptTokenRange | undefined;\r\n implementsTokenRanges: IExcerptTokenRange[];\r\n}\r\n\r\nexport interface IApiClassJson extends IApiDeclaredItemJson, IApiTypeParameterListMixinJson {\r\n extendsTokenRange?: IExcerptTokenRange;\r\n implementsTokenRanges: IExcerptTokenRange[];\r\n}\r\n\r\n/**\r\n * Represents a TypeScript class declaration.\r\n *\r\n * @remarks\r\n *\r\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\r\n * API declarations.\r\n *\r\n * `ApiClass` represents a TypeScript declaration such as this:\r\n *\r\n * ```ts\r\n * export class X { }\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class ApiClass extends ApiItemContainerMixin(\r\n ApiNameMixin(ApiTypeParameterListMixin(ApiReleaseTagMixin(ApiDeclaredItem)))\r\n) {\r\n /**\r\n * The base class that this class inherits from (using the `extends` keyword), or undefined if there is no base class.\r\n */\r\n public readonly extendsType: HeritageType | undefined;\r\n\r\n private readonly _implementsTypes: HeritageType[] = [];\r\n\r\n public constructor(options: IApiClassOptions) {\r\n super(options);\r\n\r\n if (options.extendsTokenRange) {\r\n this.extendsType = new HeritageType(this.buildExcerpt(options.extendsTokenRange));\r\n } else {\r\n this.extendsType = undefined;\r\n }\r\n\r\n for (const implementsTokenRange of options.implementsTokenRanges) {\r\n this._implementsTypes.push(new HeritageType(this.buildExcerpt(implementsTokenRange)));\r\n }\r\n }\r\n\r\n public static getContainerKey(name: string): string {\r\n return `${name}|${ApiItemKind.Class}`;\r\n }\r\n\r\n /** @override */\r\n public static onDeserializeInto(\r\n options: Partial<IApiClassOptions>,\r\n context: DeserializerContext,\r\n jsonObject: IApiClassJson\r\n ): void {\r\n super.onDeserializeInto(options, context, jsonObject);\r\n\r\n options.extendsTokenRange = jsonObject.extendsTokenRange;\r\n options.implementsTokenRanges = jsonObject.implementsTokenRanges;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.Class;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiClass.getContainerKey(this.name);\r\n }\r\n\r\n /**\r\n * The list of interfaces that this class implements using the `implements` keyword.\r\n */\r\n public get implementsTypes(): ReadonlyArray<HeritageType> {\r\n return this._implementsTypes;\r\n }\r\n\r\n /** @override */\r\n public serializeInto(jsonObject: Partial<IApiClassJson>): void {\r\n super.serializeInto(jsonObject);\r\n\r\n // Note that JSON does not support the \"undefined\" value, so we simply omit the field entirely if it is undefined\r\n if (this.extendsType) {\r\n jsonObject.extendsTokenRange = this.extendsType.excerpt.tokenRange;\r\n }\r\n\r\n jsonObject.implementsTokenRanges = this.implementsTypes.map((x) => x.excerpt.tokenRange);\r\n }\r\n\r\n /** @beta @override */\r\n public buildCanonicalReference(): DeclarationReference {\r\n const nameComponent: Component = DeclarationReference.parseComponent(this.name);\r\n return (this.parent ? this.parent.canonicalReference : DeclarationReference.empty())\r\n .addNavigationStep(Navigation.Exports, nameComponent)\r\n .withMeaning(Meaning.Class);\r\n }\r\n}\r\n"]}
|
|
@@ -58,9 +58,9 @@ export declare class ApiConstructSignature extends ApiConstructSignature_base {
|
|
|
58
58
|
constructor(options: IApiConstructSignatureOptions);
|
|
59
59
|
static getContainerKey(overloadIndex: number): string;
|
|
60
60
|
/** @override */
|
|
61
|
-
|
|
61
|
+
get kind(): ApiItemKind;
|
|
62
62
|
/** @override */
|
|
63
|
-
|
|
63
|
+
get containerKey(): string;
|
|
64
64
|
/** @beta @override */
|
|
65
65
|
buildCanonicalReference(): DeclarationReference;
|
|
66
66
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiConstructSignature.d.ts","sourceRoot":"","sources":["../../src/model/ApiConstructSignature.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAuB,MAAM,gDAAgD,CAAC;AAC3G,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EACL,yBAAyB,EACzB,iCAAiC,EAClC,MAAM,qCAAqC,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,6BACf,SAAQ,iCAAiC,EACvC,6BAA6B,EAC7B,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,qBAAsB,SAAQ,0BAE1C;gBACoB,OAAO,EAAE,6BAA6B;WAI3C,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAI5D,gBAAgB;
|
|
1
|
+
{"version":3,"file":"ApiConstructSignature.d.ts","sourceRoot":"","sources":["../../src/model/ApiConstructSignature.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAuB,MAAM,gDAAgD,CAAC;AAC3G,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EACL,yBAAyB,EACzB,iCAAiC,EAClC,MAAM,qCAAqC,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,6BACf,SAAQ,iCAAiC,EACvC,6BAA6B,EAC7B,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,qBAAa,qBAAsB,SAAQ,0BAE1C;gBACoB,OAAO,EAAE,6BAA6B;WAI3C,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAI5D,gBAAgB;IAChB,IAAW,IAAI,IAAI,WAAW,CAE7B;IAED,gBAAgB;IAChB,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAOvD"}
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
|
|
3
3
|
// See LICENSE in the project root for license information.
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
+
exports.ApiConstructSignature = void 0;
|
|
5
6
|
const DeclarationReference_1 = require("@microsoft/tsdoc/lib/beta/DeclarationReference");
|
|
6
7
|
const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem");
|
|
7
8
|
const ApiParameterListMixin_1 = require("../mixins/ApiParameterListMixin");
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiConstructSignature.js","sourceRoot":"","sources":["../../src/model/ApiConstructSignature.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D
|
|
1
|
+
{"version":3,"file":"ApiConstructSignature.js","sourceRoot":"","sources":["../../src/model/ApiConstructSignature.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAA2G;AAE3G,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAC9F,qEAA8F;AAC9F,mFAG6C;AAa7C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAa,qBAAsB,SAAQ,qDAAyB,CAClE,6CAAqB,CAAC,uCAAkB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CAAC,CAC/E;IACC,YAAmB,OAAsC;QACvD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,aAAqB;QACjD,OAAO,IAAI,6CAA8B,IAAI,aAAa,EAAE,CAAC;IAC/D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,qDAAsC;IACxC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,qBAAqB,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACnE,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,MAAM,MAAM,GAAyB,IAAI,CAAC,MAAM;YAC9C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,kBAAkB;YAChC,CAAC,CAAC,iDAAiD;gBACjD,2CAAoB,CAAC,KAAK,EAAE,CAAC,iBAAiB,oBAAqB,UAAU,CAAC,CAAC;QACnF,OAAO,MAAM,CAAC,WAAW,gCAA4B,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC9F,CAAC;CACF;AA7BD,sDA6BC","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\r\n// See LICENSE in the project root for license information.\r\n\r\nimport { DeclarationReference, Meaning, Navigation } from '@microsoft/tsdoc/lib/beta/DeclarationReference';\r\nimport { ApiItemKind } from '../items/ApiItem';\r\nimport { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem';\r\nimport { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\r\nimport { IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';\r\nimport { IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';\r\nimport {\r\n ApiTypeParameterListMixin,\r\n IApiTypeParameterListMixinOptions\r\n} from '../mixins/ApiTypeParameterListMixin';\r\n\r\n/**\r\n * Constructor options for {@link ApiConstructor}.\r\n * @public\r\n */\r\nexport interface IApiConstructSignatureOptions\r\n extends IApiTypeParameterListMixinOptions,\r\n IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiReturnTypeMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript construct signature that belongs to an `ApiInterface`.\r\n *\r\n * @remarks\r\n *\r\n * This is part of the {@link ApiModel} hierarchy of classes, which are serializable representations of\r\n * API declarations.\r\n *\r\n * `ApiConstructSignature` represents a construct signature using the `new` keyword such as in this example:\r\n *\r\n * ```ts\r\n * export interface IVector {\r\n * x: number;\r\n * y: number;\r\n * }\r\n *\r\n * export interface IVectorConstructor {\r\n * // A construct signature:\r\n * new(x: number, y: number): IVector;\r\n * }\r\n *\r\n * export function createVector(vectorConstructor: IVectorConstructor,\r\n * x: number, y: number): IVector {\r\n * return new vectorConstructor(x, y);\r\n * }\r\n *\r\n * class Vector implements IVector {\r\n * public x: number;\r\n * public y: number;\r\n * public constructor(x: number, y: number) {\r\n * this.x = x;\r\n * this.y = y;\r\n * }\r\n * }\r\n *\r\n * let vector: Vector = createVector(Vector, 1, 2);\r\n * ```\r\n *\r\n * Compare with {@link ApiConstructor}, which describes the class constructor itself.\r\n *\r\n * @public\r\n */\r\nexport class ApiConstructSignature extends ApiTypeParameterListMixin(\r\n ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem)))\r\n) {\r\n public constructor(options: IApiConstructSignatureOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(overloadIndex: number): string {\r\n return `|${ApiItemKind.ConstructSignature}|${overloadIndex}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.ConstructSignature;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiConstructSignature.getContainerKey(this.overloadIndex);\r\n }\r\n\r\n /** @beta @override */\r\n public buildCanonicalReference(): DeclarationReference {\r\n const parent: DeclarationReference = this.parent\r\n ? this.parent.canonicalReference\r\n : // .withMeaning() requires some kind of component\r\n DeclarationReference.empty().addNavigationStep(Navigation.Members, '(parent)');\r\n return parent.withMeaning(Meaning.ConstructSignature).withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
|
|
@@ -41,9 +41,9 @@ export declare class ApiConstructor extends ApiConstructor_base {
|
|
|
41
41
|
constructor(options: IApiConstructorOptions);
|
|
42
42
|
static getContainerKey(overloadIndex: number): string;
|
|
43
43
|
/** @override */
|
|
44
|
-
|
|
44
|
+
get kind(): ApiItemKind;
|
|
45
45
|
/** @override */
|
|
46
|
-
|
|
46
|
+
get containerKey(): string;
|
|
47
47
|
/** @beta @override */
|
|
48
48
|
buildCanonicalReference(): DeclarationReference;
|
|
49
49
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApiConstructor.d.ts","sourceRoot":"","sources":["../../src/model/ApiConstructor.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAuB,MAAM,gDAAgD,CAAC;AAC3G,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAE9F;;;GAGG;AACH,MAAM,WAAW,sBACf,SAAQ,6BAA6B,EACnC,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,cAAe,SAAQ,mBAA0D;gBACzE,OAAO,EAAE,sBAAsB;WAIpC,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAI5D,gBAAgB;
|
|
1
|
+
{"version":3,"file":"ApiConstructor.d.ts","sourceRoot":"","sources":["../../src/model/ApiConstructor.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAuB,MAAM,gDAAgD,CAAC;AAC3G,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,uBAAuB,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,6BAA6B,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAE9F;;;GAGG;AACH,MAAM,WAAW,sBACf,SAAQ,6BAA6B,EACnC,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,cAAe,SAAQ,mBAA0D;gBACzE,OAAO,EAAE,sBAAsB;WAIpC,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAI5D,gBAAgB;IAChB,IAAW,IAAI,IAAI,WAAW,CAE7B;IAED,gBAAgB;IAChB,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAOvD"}
|