@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.
Files changed (141) hide show
  1. package/CHANGELOG.json +75 -0
  2. package/CHANGELOG.md +29 -1
  3. package/README.md +9 -0
  4. package/dist/rollup.d.ts +62 -62
  5. package/dist/tsdoc-metadata.json +1 -1
  6. package/lib/aedoc/AedocDefinitions.d.ts +1 -1
  7. package/lib/aedoc/AedocDefinitions.d.ts.map +1 -1
  8. package/lib/aedoc/AedocDefinitions.js +2 -1
  9. package/lib/aedoc/AedocDefinitions.js.map +1 -1
  10. package/lib/aedoc/ReleaseTag.js +1 -0
  11. package/lib/aedoc/ReleaseTag.js.map +1 -1
  12. package/lib/index.js +37 -37
  13. package/lib/index.js.map +1 -1
  14. package/lib/items/ApiDeclaredItem.d.ts +2 -2
  15. package/lib/items/ApiDeclaredItem.d.ts.map +1 -1
  16. package/lib/items/ApiDeclaredItem.js +1 -0
  17. package/lib/items/ApiDeclaredItem.js.map +1 -1
  18. package/lib/items/ApiDocumentedItem.d.ts +1 -1
  19. package/lib/items/ApiDocumentedItem.d.ts.map +1 -1
  20. package/lib/items/ApiDocumentedItem.js +21 -1
  21. package/lib/items/ApiDocumentedItem.js.map +1 -1
  22. package/lib/items/ApiItem.d.ts +6 -6
  23. package/lib/items/ApiItem.d.ts.map +1 -1
  24. package/lib/items/ApiItem.js +1 -0
  25. package/lib/items/ApiItem.js.map +1 -1
  26. package/lib/items/ApiPropertyItem.d.ts +1 -1
  27. package/lib/items/ApiPropertyItem.d.ts.map +1 -1
  28. package/lib/items/ApiPropertyItem.js +1 -0
  29. package/lib/items/ApiPropertyItem.js.map +1 -1
  30. package/lib/mixins/ApiItemContainerMixin.js +1 -0
  31. package/lib/mixins/ApiItemContainerMixin.js.map +1 -1
  32. package/lib/mixins/ApiNameMixin.js +1 -0
  33. package/lib/mixins/ApiNameMixin.js.map +1 -1
  34. package/lib/mixins/ApiParameterListMixin.js +1 -0
  35. package/lib/mixins/ApiParameterListMixin.js.map +1 -1
  36. package/lib/mixins/ApiReleaseTagMixin.d.ts.map +1 -1
  37. package/lib/mixins/ApiReleaseTagMixin.js +4 -1
  38. package/lib/mixins/ApiReleaseTagMixin.js.map +1 -1
  39. package/lib/mixins/ApiReturnTypeMixin.js +1 -0
  40. package/lib/mixins/ApiReturnTypeMixin.js.map +1 -1
  41. package/lib/mixins/ApiStaticMixin.js +1 -0
  42. package/lib/mixins/ApiStaticMixin.js.map +1 -1
  43. package/lib/mixins/ApiTypeParameterListMixin.js +1 -0
  44. package/lib/mixins/ApiTypeParameterListMixin.js.map +1 -1
  45. package/lib/mixins/Excerpt.d.ts +5 -5
  46. package/lib/mixins/Excerpt.d.ts.map +1 -1
  47. package/lib/mixins/Excerpt.js +1 -0
  48. package/lib/mixins/Excerpt.js.map +1 -1
  49. package/lib/model/ApiCallSignature.d.ts +2 -2
  50. package/lib/model/ApiCallSignature.d.ts.map +1 -1
  51. package/lib/model/ApiCallSignature.js +1 -0
  52. package/lib/model/ApiCallSignature.js.map +1 -1
  53. package/lib/model/ApiClass.d.ts +3 -3
  54. package/lib/model/ApiClass.d.ts.map +1 -1
  55. package/lib/model/ApiClass.js +1 -0
  56. package/lib/model/ApiClass.js.map +1 -1
  57. package/lib/model/ApiConstructSignature.d.ts +2 -2
  58. package/lib/model/ApiConstructSignature.d.ts.map +1 -1
  59. package/lib/model/ApiConstructSignature.js +1 -0
  60. package/lib/model/ApiConstructSignature.js.map +1 -1
  61. package/lib/model/ApiConstructor.d.ts +2 -2
  62. package/lib/model/ApiConstructor.d.ts.map +1 -1
  63. package/lib/model/ApiConstructor.js +1 -0
  64. package/lib/model/ApiConstructor.js.map +1 -1
  65. package/lib/model/ApiEntryPoint.d.ts +3 -3
  66. package/lib/model/ApiEntryPoint.d.ts.map +1 -1
  67. package/lib/model/ApiEntryPoint.js +1 -0
  68. package/lib/model/ApiEntryPoint.js.map +1 -1
  69. package/lib/model/ApiEnum.d.ts +3 -3
  70. package/lib/model/ApiEnum.d.ts.map +1 -1
  71. package/lib/model/ApiEnum.js +1 -0
  72. package/lib/model/ApiEnum.js.map +1 -1
  73. package/lib/model/ApiEnumMember.d.ts +2 -2
  74. package/lib/model/ApiEnumMember.d.ts.map +1 -1
  75. package/lib/model/ApiEnumMember.js +1 -0
  76. package/lib/model/ApiEnumMember.js.map +1 -1
  77. package/lib/model/ApiFunction.d.ts +2 -2
  78. package/lib/model/ApiFunction.d.ts.map +1 -1
  79. package/lib/model/ApiFunction.js +1 -0
  80. package/lib/model/ApiFunction.js.map +1 -1
  81. package/lib/model/ApiIndexSignature.d.ts +2 -2
  82. package/lib/model/ApiIndexSignature.d.ts.map +1 -1
  83. package/lib/model/ApiIndexSignature.js +1 -0
  84. package/lib/model/ApiIndexSignature.js.map +1 -1
  85. package/lib/model/ApiInterface.d.ts +3 -3
  86. package/lib/model/ApiInterface.d.ts.map +1 -1
  87. package/lib/model/ApiInterface.js +1 -0
  88. package/lib/model/ApiInterface.js.map +1 -1
  89. package/lib/model/ApiMethod.d.ts +2 -2
  90. package/lib/model/ApiMethod.d.ts.map +1 -1
  91. package/lib/model/ApiMethod.js +1 -0
  92. package/lib/model/ApiMethod.js.map +1 -1
  93. package/lib/model/ApiMethodSignature.d.ts +2 -2
  94. package/lib/model/ApiMethodSignature.d.ts.map +1 -1
  95. package/lib/model/ApiMethodSignature.js +1 -0
  96. package/lib/model/ApiMethodSignature.js.map +1 -1
  97. package/lib/model/ApiModel.d.ts +3 -3
  98. package/lib/model/ApiModel.d.ts.map +1 -1
  99. package/lib/model/ApiModel.js +1 -0
  100. package/lib/model/ApiModel.js.map +1 -1
  101. package/lib/model/ApiNamespace.d.ts +2 -2
  102. package/lib/model/ApiNamespace.d.ts.map +1 -1
  103. package/lib/model/ApiNamespace.js +1 -0
  104. package/lib/model/ApiNamespace.js.map +1 -1
  105. package/lib/model/ApiPackage.d.ts +3 -3
  106. package/lib/model/ApiPackage.d.ts.map +1 -1
  107. package/lib/model/ApiPackage.js +1 -0
  108. package/lib/model/ApiPackage.js.map +1 -1
  109. package/lib/model/ApiProperty.d.ts +2 -2
  110. package/lib/model/ApiProperty.d.ts.map +1 -1
  111. package/lib/model/ApiProperty.js +1 -0
  112. package/lib/model/ApiProperty.js.map +1 -1
  113. package/lib/model/ApiPropertySignature.d.ts +2 -2
  114. package/lib/model/ApiPropertySignature.d.ts.map +1 -1
  115. package/lib/model/ApiPropertySignature.js +1 -0
  116. package/lib/model/ApiPropertySignature.js.map +1 -1
  117. package/lib/model/ApiTypeAlias.d.ts +2 -2
  118. package/lib/model/ApiTypeAlias.d.ts.map +1 -1
  119. package/lib/model/ApiTypeAlias.js +1 -0
  120. package/lib/model/ApiTypeAlias.js.map +1 -1
  121. package/lib/model/ApiVariable.d.ts +2 -2
  122. package/lib/model/ApiVariable.d.ts.map +1 -1
  123. package/lib/model/ApiVariable.js +1 -0
  124. package/lib/model/ApiVariable.js.map +1 -1
  125. package/lib/model/Deserializer.js +1 -0
  126. package/lib/model/Deserializer.js.map +1 -1
  127. package/lib/model/DeserializerContext.js +1 -0
  128. package/lib/model/DeserializerContext.js.map +1 -1
  129. package/lib/model/HeritageType.js +1 -0
  130. package/lib/model/HeritageType.js.map +1 -1
  131. package/lib/model/ModelReferenceResolver.js +1 -0
  132. package/lib/model/ModelReferenceResolver.js.map +1 -1
  133. package/lib/model/Parameter.d.ts +1 -1
  134. package/lib/model/Parameter.d.ts.map +1 -1
  135. package/lib/model/Parameter.js +1 -0
  136. package/lib/model/Parameter.js.map +1 -1
  137. package/lib/model/TypeParameter.d.ts +1 -1
  138. package/lib/model/TypeParameter.d.ts.map +1 -1
  139. package/lib/model/TypeParameter.js +1 -0
  140. package/lib/model/TypeParameter.js.map +1 -1
  141. package/package.json +6 -6
@@ -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.ApiConstructor = 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":"ApiConstructor.js","sourceRoot":"","sources":["../../src/model/ApiConstructor.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,yFAA2G;AAE3G,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAW9F;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,cAAe,SAAQ,6CAAqB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC;IAC5F,YAAmB,OAA+B;QAChD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,aAAqB;QACjD,OAAO,IAAI,+BAAuB,IAAI,aAAa,EAAE,CAAC;IACxD,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,uCAA+B;IACjC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,cAAc,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC5D,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,iCAAqB,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACvF,CAAC;CACF;AA3BD,wCA2BC","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\n\r\n/**\r\n * Constructor options for {@link ApiConstructor}.\r\n * @public\r\n */\r\nexport interface IApiConstructorOptions\r\n extends IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript class constructor declaration that belongs to an `ApiClass`.\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 * `ApiConstructor` represents a declaration using the `constructor` keyword such as in this example:\r\n *\r\n * ```ts\r\n * export class Vector {\r\n * public x: number;\r\n * public y: number;\r\n *\r\n * // A class constructor:\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 *\r\n * Compare with {@link ApiConstructSignature}, which describes the construct signature for a class constructor.\r\n *\r\n * @public\r\n */\r\nexport class ApiConstructor extends ApiParameterListMixin(ApiReleaseTagMixin(ApiDeclaredItem)) {\r\n public constructor(options: IApiConstructorOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(overloadIndex: number): string {\r\n return `|${ApiItemKind.Constructor}|${overloadIndex}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.Constructor;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiConstructor.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.Constructor).withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ApiConstructor.js","sourceRoot":"","sources":["../../src/model/ApiConstructor.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAA2G;AAE3G,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAW9F;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,cAAe,SAAQ,6CAAqB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC;IAC5F,YAAmB,OAA+B;QAChD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,aAAqB;QACjD,OAAO,IAAI,+BAAuB,IAAI,aAAa,EAAE,CAAC;IACxD,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,uCAA+B;IACjC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,cAAc,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC5D,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,iCAAqB,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IACvF,CAAC;CACF;AA3BD,wCA2BC","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\n\r\n/**\r\n * Constructor options for {@link ApiConstructor}.\r\n * @public\r\n */\r\nexport interface IApiConstructorOptions\r\n extends IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript class constructor declaration that belongs to an `ApiClass`.\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 * `ApiConstructor` represents a declaration using the `constructor` keyword such as in this example:\r\n *\r\n * ```ts\r\n * export class Vector {\r\n * public x: number;\r\n * public y: number;\r\n *\r\n * // A class constructor:\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 *\r\n * Compare with {@link ApiConstructSignature}, which describes the construct signature for a class constructor.\r\n *\r\n * @public\r\n */\r\nexport class ApiConstructor extends ApiParameterListMixin(ApiReleaseTagMixin(ApiDeclaredItem)) {\r\n public constructor(options: IApiConstructorOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(overloadIndex: number): string {\r\n return `|${ApiItemKind.Constructor}|${overloadIndex}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.Constructor;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiConstructor.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.Constructor).withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
@@ -39,9 +39,9 @@ declare const ApiEntryPoint_base: typeof ApiItem & (new (...args: any[]) => ApiN
39
39
  export declare class ApiEntryPoint extends ApiEntryPoint_base {
40
40
  constructor(options: IApiEntryPointOptions);
41
41
  /** @override */
42
- readonly kind: ApiItemKind;
42
+ get kind(): ApiItemKind;
43
43
  /** @override */
44
- readonly containerKey: string;
44
+ get containerKey(): string;
45
45
  /**
46
46
  * The module path for this entry point, relative to the parent `ApiPackage`. In the current implementation,
47
47
  * this is always the empty string, indicating the default entry point.
@@ -54,7 +54,7 @@ export declare class ApiEntryPoint extends ApiEntryPoint_base {
54
54
  *
55
55
  * The `ApiEntryPoint.name` property stores the same value as `ApiEntryPoint.importPath`.
56
56
  */
57
- readonly importPath: string;
57
+ get importPath(): string;
58
58
  /** @beta @override */
59
59
  buildCanonicalReference(): DeclarationReference;
60
60
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ApiEntryPoint.d.ts","sourceRoot":"","sources":["../../src/model/ApiEntryPoint.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gDAAgD,CAAC;AACtF,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAG5E;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,6BAA6B,EAAE,oBAAoB;CAAG;;AAErG;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,aAAc,SAAQ,kBAA4C;gBAC1D,OAAO,EAAE,qBAAqB;IAIjD,gBAAgB;aACL,IAAI,EAAI,WAAW;IAI9B,gBAAgB;aACL,YAAY,EAAI,MAAM;IAKjC;;;;;;;;;;;OAWG;aACQ,UAAU,EAAI,MAAM;IAI/B,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAOvD"}
1
+ {"version":3,"file":"ApiEntryPoint.d.ts","sourceRoot":"","sources":["../../src/model/ApiEntryPoint.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gDAAgD,CAAC;AACtF,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAG5E;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,6BAA6B,EAAE,oBAAoB;CAAG;;AAErG;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,qBAAa,aAAc,SAAQ,kBAA4C;gBAC1D,OAAO,EAAE,qBAAqB;IAIjD,gBAAgB;IAChB,IAAW,IAAI,IAAI,WAAW,CAE7B;IAED,gBAAgB;IAChB,IAAW,YAAY,IAAI,MAAM,CAGhC;IAED;;;;;;;;;;;OAWG;IACH,IAAW,UAAU,IAAI,MAAM,CAE9B;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.ApiEntryPoint = void 0;
5
6
  const DeclarationReference_1 = require("@microsoft/tsdoc/lib/beta/DeclarationReference");
6
7
  const ApiItem_1 = require("../items/ApiItem");
7
8
  const ApiItemContainerMixin_1 = require("../mixins/ApiItemContainerMixin");
@@ -1 +1 @@
1
- {"version":3,"file":"ApiEntryPoint.js","sourceRoot":"","sources":["../../src/model/ApiEntryPoint.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,yFAAsF;AACtF,8CAAwD;AACxD,2EAAuG;AACvG,yDAA4E;AAC5E,6CAA0C;AAQ1C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,aAAc,SAAQ,6CAAqB,CAAC,2BAAY,CAAC,iBAAO,CAAC,CAAC;IAC7E,YAAmB,OAA8B;QAC/C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,qCAA8B;IAChC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,uFAAuF;QACvF,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,IAAI,IAAI,CAAC,MAAM,YAAY,uBAAU,EAAE;YACrC,OAAO,2CAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;SACxE;QAED,OAAO,2CAAoB,CAAC,KAAK,EAAE,CAAC;IACtC,CAAC;CACF;AAxCD,sCAwCC","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 { ApiItem, ApiItemKind } from '../items/ApiItem';\r\nimport { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin';\r\nimport { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\nimport { ApiPackage } from './ApiPackage';\r\n\r\n/**\r\n * Constructor options for {@link ApiEntryPoint}.\r\n * @public\r\n */\r\nexport interface IApiEntryPointOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions {}\r\n\r\n/**\r\n * Represents the entry point for an NPM package.\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 * `ApiEntryPoint` represents the entry point to an NPM package. API Extractor does not currently support\r\n * analysis of multiple entry points, but the `ApiEntryPoint` object is included to support a future feature.\r\n * In the current implementation, `ApiEntryPoint.importPath` is always the empty string.\r\n *\r\n * For example, suppose the package.json file looks like this:\r\n *\r\n * ```json\r\n * {\r\n * \"name\": \"example-library\",\r\n * \"version\": \"1.0.0\",\r\n * \"main\": \"./lib/index.js\",\r\n * \"typings\": \"./lib/index.d.ts\"\r\n * }\r\n * ```\r\n *\r\n * In this example, the `ApiEntryPoint` would represent the TypeScript module for `./lib/index.js`.\r\n *\r\n * @public\r\n */\r\nexport class ApiEntryPoint extends ApiItemContainerMixin(ApiNameMixin(ApiItem)) {\r\n public constructor(options: IApiEntryPointOptions) {\r\n super(options);\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.EntryPoint;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n // No prefix needed, because ApiEntryPoint is the only possible member of an ApiPackage\r\n return this.name;\r\n }\r\n\r\n /**\r\n * The module path for this entry point, relative to the parent `ApiPackage`. In the current implementation,\r\n * this is always the empty string, indicating the default entry point.\r\n *\r\n * @remarks\r\n *\r\n * API Extractor does not currently support analysis of multiple entry points. If that feature is implemented\r\n * in the future, then the `ApiEntryPoint.importPath` will be used to distinguish different entry points,\r\n * for example: `controls/Button` in `import { Button } from \"example-package/controls/Button\";`.\r\n *\r\n * The `ApiEntryPoint.name` property stores the same value as `ApiEntryPoint.importPath`.\r\n */\r\n public get importPath(): string {\r\n return this.name;\r\n }\r\n\r\n /** @beta @override */\r\n public buildCanonicalReference(): DeclarationReference {\r\n if (this.parent instanceof ApiPackage) {\r\n return DeclarationReference.package(this.parent.name, this.importPath);\r\n }\r\n\r\n return DeclarationReference.empty();\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ApiEntryPoint.js","sourceRoot":"","sources":["../../src/model/ApiEntryPoint.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAAsF;AACtF,8CAAwD;AACxD,2EAAuG;AACvG,yDAA4E;AAC5E,6CAA0C;AAQ1C;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,MAAa,aAAc,SAAQ,6CAAqB,CAAC,2BAAY,CAAC,iBAAO,CAAC,CAAC;IAC7E,YAAmB,OAA8B;QAC/C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,qCAA8B;IAChC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,uFAAuF;QACvF,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAW,UAAU;QACnB,OAAO,IAAI,CAAC,IAAI,CAAC;IACnB,CAAC;IAED,sBAAsB;IACf,uBAAuB;QAC5B,IAAI,IAAI,CAAC,MAAM,YAAY,uBAAU,EAAE;YACrC,OAAO,2CAAoB,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;SACxE;QAED,OAAO,2CAAoB,CAAC,KAAK,EAAE,CAAC;IACtC,CAAC;CACF;AAxCD,sCAwCC","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 { ApiItem, ApiItemKind } from '../items/ApiItem';\r\nimport { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin';\r\nimport { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\nimport { ApiPackage } from './ApiPackage';\r\n\r\n/**\r\n * Constructor options for {@link ApiEntryPoint}.\r\n * @public\r\n */\r\nexport interface IApiEntryPointOptions extends IApiItemContainerMixinOptions, IApiNameMixinOptions {}\r\n\r\n/**\r\n * Represents the entry point for an NPM package.\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 * `ApiEntryPoint` represents the entry point to an NPM package. API Extractor does not currently support\r\n * analysis of multiple entry points, but the `ApiEntryPoint` object is included to support a future feature.\r\n * In the current implementation, `ApiEntryPoint.importPath` is always the empty string.\r\n *\r\n * For example, suppose the package.json file looks like this:\r\n *\r\n * ```json\r\n * {\r\n * \"name\": \"example-library\",\r\n * \"version\": \"1.0.0\",\r\n * \"main\": \"./lib/index.js\",\r\n * \"typings\": \"./lib/index.d.ts\"\r\n * }\r\n * ```\r\n *\r\n * In this example, the `ApiEntryPoint` would represent the TypeScript module for `./lib/index.js`.\r\n *\r\n * @public\r\n */\r\nexport class ApiEntryPoint extends ApiItemContainerMixin(ApiNameMixin(ApiItem)) {\r\n public constructor(options: IApiEntryPointOptions) {\r\n super(options);\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.EntryPoint;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n // No prefix needed, because ApiEntryPoint is the only possible member of an ApiPackage\r\n return this.name;\r\n }\r\n\r\n /**\r\n * The module path for this entry point, relative to the parent `ApiPackage`. In the current implementation,\r\n * this is always the empty string, indicating the default entry point.\r\n *\r\n * @remarks\r\n *\r\n * API Extractor does not currently support analysis of multiple entry points. If that feature is implemented\r\n * in the future, then the `ApiEntryPoint.importPath` will be used to distinguish different entry points,\r\n * for example: `controls/Button` in `import { Button } from \"example-package/controls/Button\";`.\r\n *\r\n * The `ApiEntryPoint.name` property stores the same value as `ApiEntryPoint.importPath`.\r\n */\r\n public get importPath(): string {\r\n return this.name;\r\n }\r\n\r\n /** @beta @override */\r\n public buildCanonicalReference(): DeclarationReference {\r\n if (this.parent instanceof ApiPackage) {\r\n return DeclarationReference.package(this.parent.name, this.importPath);\r\n }\r\n\r\n return DeclarationReference.empty();\r\n }\r\n}\r\n"]}
@@ -36,11 +36,11 @@ export declare class ApiEnum extends ApiEnum_base {
36
36
  constructor(options: IApiEnumOptions);
37
37
  static getContainerKey(name: string): string;
38
38
  /** @override */
39
- readonly kind: ApiItemKind;
39
+ get kind(): ApiItemKind;
40
40
  /** @override */
41
- readonly members: ReadonlyArray<ApiEnumMember>;
41
+ get members(): ReadonlyArray<ApiEnumMember>;
42
42
  /** @override */
43
- readonly containerKey: string;
43
+ get containerKey(): string;
44
44
  /** @override */
45
45
  addMember(member: ApiEnumMember): void;
46
46
  /** @beta @override */
@@ -1 +1 @@
1
- {"version":3,"file":"ApiEnum.d.ts","sourceRoot":"","sources":["../../src/model/ApiEnum.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,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE5E;;;GAGG;AACH,MAAM,WAAW,eACf,SAAQ,6BAA6B,EACnC,oBAAoB,EACpB,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,OAAQ,SAAQ,YAAwE;gBAChF,OAAO,EAAE,eAAe;WAI7B,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAInD,gBAAgB;aACL,IAAI,EAAI,WAAW;IAI9B,gBAAgB;aACL,OAAO,EAAI,aAAa,CAAC,aAAa,CAAC;IAIlD,gBAAgB;aACL,YAAY,EAAI,MAAM;IAIjC,gBAAgB;IACT,SAAS,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAO7C,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAMvD"}
1
+ {"version":3,"file":"ApiEnum.d.ts","sourceRoot":"","sources":["../../src/model/ApiEnum.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,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAE5E;;;GAGG;AACH,MAAM,WAAW,eACf,SAAQ,6BAA6B,EACnC,oBAAoB,EACpB,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,OAAQ,SAAQ,YAAwE;gBAChF,OAAO,EAAE,eAAe;WAI7B,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAInD,gBAAgB;IAChB,IAAW,IAAI,IAAI,WAAW,CAE7B;IAED,gBAAgB;IAChB,IAAW,OAAO,IAAI,aAAa,CAAC,aAAa,CAAC,CAEjD;IAED,gBAAgB;IAChB,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED,gBAAgB;IACT,SAAS,CAAC,MAAM,EAAE,aAAa,GAAG,IAAI;IAO7C,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAMvD"}
@@ -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.ApiEnum = void 0;
5
6
  const DeclarationReference_1 = require("@microsoft/tsdoc/lib/beta/DeclarationReference");
6
7
  const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem");
7
8
  const ApiReleaseTagMixin_1 = require("../mixins/ApiReleaseTagMixin");
@@ -1 +1 @@
1
- {"version":3,"file":"ApiEnum.js","sourceRoot":"","sources":["../../src/model/ApiEnum.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,yFAKwD;AAExD,8DAAoF;AACpF,qEAA8F;AAC9F,2EAAuG;AAEvG,yDAA4E;AAY5E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,OAAQ,SAAQ,6CAAqB,CAAC,2BAAY,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CAAC;IACnG,YAAmB,OAAwB;QACzC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,iBAAgB,EAAE,CAAC;IACvC,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,yBAAwB;IAC1B,CAAC;IAED,gBAAgB;IAChB,IAAW,OAAO;QAChB,OAAO,KAAK,CAAC,OAAuC,CAAC;IACvD,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACT,SAAS,CAAC,MAAqB;QACpC,IAAI,MAAM,CAAC,IAAI,kCAA2B,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC1E;QACD,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1B,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,mBAAc,CAAC;IAC/B,CAAC;CACF;AAvCD,0BAuCC","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 } from '../items/ApiDeclaredItem';\r\nimport { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\r\nimport { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin';\r\nimport { ApiEnumMember } from './ApiEnumMember';\r\nimport { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\n\r\n/**\r\n * Constructor options for {@link ApiEnum}.\r\n * @public\r\n */\r\nexport interface IApiEnumOptions\r\n extends IApiItemContainerMixinOptions,\r\n IApiNameMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript enum 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 * `ApiEnum` represents an enum declaration such as `FontSizes` in the example below:\r\n *\r\n * ```ts\r\n * export enum FontSizes {\r\n * Small = 100,\r\n * Medium = 200,\r\n * Large = 300\r\n * }\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class ApiEnum extends ApiItemContainerMixin(ApiNameMixin(ApiReleaseTagMixin(ApiDeclaredItem))) {\r\n public constructor(options: IApiEnumOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(name: string): string {\r\n return `${name}|${ApiItemKind.Enum}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.Enum;\r\n }\r\n\r\n /** @override */\r\n public get members(): ReadonlyArray<ApiEnumMember> {\r\n return super.members as ReadonlyArray<ApiEnumMember>;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiEnum.getContainerKey(this.name);\r\n }\r\n\r\n /** @override */\r\n public addMember(member: ApiEnumMember): void {\r\n if (member.kind !== ApiItemKind.EnumMember) {\r\n throw new Error('Only ApiEnumMember objects can be added to an ApiEnum');\r\n }\r\n super.addMember(member);\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.Enum);\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ApiEnum.js","sourceRoot":"","sources":["../../src/model/ApiEnum.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAKwD;AAExD,8DAAoF;AACpF,qEAA8F;AAC9F,2EAAuG;AAEvG,yDAA4E;AAY5E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,OAAQ,SAAQ,6CAAqB,CAAC,2BAAY,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CAAC;IACnG,YAAmB,OAAwB;QACzC,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,iBAAgB,EAAE,CAAC;IACvC,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,yBAAwB;IAC1B,CAAC;IAED,gBAAgB;IAChB,IAAW,OAAO;QAChB,OAAO,KAAK,CAAC,OAAuC,CAAC;IACvD,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,OAAO,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACT,SAAS,CAAC,MAAqB;QACpC,IAAI,MAAM,CAAC,IAAI,kCAA2B,EAAE;YAC1C,MAAM,IAAI,KAAK,CAAC,uDAAuD,CAAC,CAAC;SAC1E;QACD,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAC1B,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,mBAAc,CAAC;IAC/B,CAAC;CACF;AAvCD,0BAuCC","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 } from '../items/ApiDeclaredItem';\r\nimport { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\r\nimport { ApiItemContainerMixin, IApiItemContainerMixinOptions } from '../mixins/ApiItemContainerMixin';\r\nimport { ApiEnumMember } from './ApiEnumMember';\r\nimport { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\n\r\n/**\r\n * Constructor options for {@link ApiEnum}.\r\n * @public\r\n */\r\nexport interface IApiEnumOptions\r\n extends IApiItemContainerMixinOptions,\r\n IApiNameMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript enum 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 * `ApiEnum` represents an enum declaration such as `FontSizes` in the example below:\r\n *\r\n * ```ts\r\n * export enum FontSizes {\r\n * Small = 100,\r\n * Medium = 200,\r\n * Large = 300\r\n * }\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class ApiEnum extends ApiItemContainerMixin(ApiNameMixin(ApiReleaseTagMixin(ApiDeclaredItem))) {\r\n public constructor(options: IApiEnumOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(name: string): string {\r\n return `${name}|${ApiItemKind.Enum}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.Enum;\r\n }\r\n\r\n /** @override */\r\n public get members(): ReadonlyArray<ApiEnumMember> {\r\n return super.members as ReadonlyArray<ApiEnumMember>;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiEnum.getContainerKey(this.name);\r\n }\r\n\r\n /** @override */\r\n public addMember(member: ApiEnumMember): void {\r\n if (member.kind !== ApiItemKind.EnumMember) {\r\n throw new Error('Only ApiEnumMember objects can be added to an ApiEnum');\r\n }\r\n super.addMember(member);\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.Enum);\r\n }\r\n}\r\n"]}
@@ -46,9 +46,9 @@ export declare class ApiEnumMember extends ApiEnumMember_base {
46
46
  /** @override */
47
47
  static onDeserializeInto(options: Partial<IApiEnumMemberOptions>, context: DeserializerContext, jsonObject: IApiEnumMemberJson): void;
48
48
  /** @override */
49
- readonly kind: ApiItemKind;
49
+ get kind(): ApiItemKind;
50
50
  /** @override */
51
- readonly containerKey: string;
51
+ get containerKey(): string;
52
52
  /** @override */
53
53
  serializeInto(jsonObject: Partial<IApiEnumMemberJson>): void;
54
54
  /** @beta @override */
@@ -1 +1 @@
1
- {"version":3,"file":"ApiEnumMember.d.ts","sourceRoot":"","sources":["../../src/model/ApiEnumMember.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,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,qBACf,SAAQ,oBAAoB,EAC1B,0BAA0B,EAC1B,uBAAuB;IACzB,qBAAqB,EAAE,kBAAkB,CAAC;CAC3C;AAED,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D,qBAAqB,EAAE,kBAAkB,CAAC;CAC3C;;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,aAAc,SAAQ,kBAAiD;IAClF;;OAEG;IACH,SAAgB,kBAAkB,EAAE,OAAO,CAAC;gBAEzB,OAAO,EAAE,qBAAqB;WAMnC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAKnD,gBAAgB;WACF,iBAAiB,CAC7B,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,EACvC,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,kBAAkB,GAC7B,IAAI;IAMP,gBAAgB;aACL,IAAI,EAAI,WAAW;IAI9B,gBAAgB;aACL,YAAY,EAAI,MAAM;IAIjC,gBAAgB;IACT,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,IAAI;IAMnE,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAMvD"}
1
+ {"version":3,"file":"ApiEnumMember.d.ts","sourceRoot":"","sources":["../../src/model/ApiEnumMember.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,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AAChE,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,qBACf,SAAQ,oBAAoB,EAC1B,0BAA0B,EAC1B,uBAAuB;IACzB,qBAAqB,EAAE,kBAAkB,CAAC;CAC3C;AAED,MAAM,WAAW,kBAAmB,SAAQ,oBAAoB;IAC9D,qBAAqB,EAAE,kBAAkB,CAAC;CAC3C;;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,aAAc,SAAQ,kBAAiD;IAClF;;OAEG;IACH,SAAgB,kBAAkB,EAAE,OAAO,CAAC;gBAEzB,OAAO,EAAE,qBAAqB;WAMnC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAKnD,gBAAgB;WACF,iBAAiB,CAC7B,OAAO,EAAE,OAAO,CAAC,qBAAqB,CAAC,EACvC,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,kBAAkB,GAC7B,IAAI;IAMP,gBAAgB;IAChB,IAAW,IAAI,IAAI,WAAW,CAE7B;IAED,gBAAgB;IAChB,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED,gBAAgB;IACT,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,kBAAkB,CAAC,GAAG,IAAI;IAMnE,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAMvD"}
@@ -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.ApiEnumMember = void 0;
5
6
  const DeclarationReference_1 = require("@microsoft/tsdoc/lib/beta/DeclarationReference");
6
7
  const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem");
7
8
  const ApiReleaseTagMixin_1 = require("../mixins/ApiReleaseTagMixin");
@@ -1 +1 @@
1
- {"version":3,"file":"ApiEnumMember.js","sourceRoot":"","sources":["../../src/model/ApiEnumMember.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,yFAKwD;AAExD,8DAA0G;AAC1G,qEAA8F;AAE9F,yDAA4E;AAkB5E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,aAAc,SAAQ,2BAAY,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC;IAMlF,YAAmB,OAA8B;QAC/C,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC7E,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,oFAAoF;QACpF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAAuC,EACvC,OAA4B,EAC5B,UAA8B;QAE9B,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,OAAO,CAAC,qBAAqB,GAAG,UAAU,CAAC,qBAAqB,CAAC;IACnE,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,qCAA8B;IAChC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,UAAuC;QAC1D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEhC,UAAU,CAAC,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC;IACxE,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,uBAAgB,CAAC;IACjC,CAAC;CACF;AApDD,sCAoDC","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 { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\r\nimport { Excerpt, IExcerptTokenRange } from '../mixins/Excerpt';\r\nimport { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\nimport { DeserializerContext } from './DeserializerContext';\r\n\r\n/**\r\n * Constructor options for {@link ApiEnumMember}.\r\n * @public\r\n */\r\nexport interface IApiEnumMemberOptions\r\n extends IApiNameMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiDeclaredItemOptions {\r\n initializerTokenRange: IExcerptTokenRange;\r\n}\r\n\r\nexport interface IApiEnumMemberJson extends IApiDeclaredItemJson {\r\n initializerTokenRange: IExcerptTokenRange;\r\n}\r\n\r\n/**\r\n * Represents a member of a TypeScript enum 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 * `ApiEnumMember` represents an enum member such as `Small = 100` in the example below:\r\n *\r\n * ```ts\r\n * export enum FontSizes {\r\n * Small = 100,\r\n * Medium = 200,\r\n * Large = 300\r\n * }\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class ApiEnumMember extends ApiNameMixin(ApiReleaseTagMixin(ApiDeclaredItem)) {\r\n /**\r\n * An {@link Excerpt} that describes the value of the enum member.\r\n */\r\n public readonly initializerExcerpt: Excerpt;\r\n\r\n public constructor(options: IApiEnumMemberOptions) {\r\n super(options);\r\n\r\n this.initializerExcerpt = this.buildExcerpt(options.initializerTokenRange);\r\n }\r\n\r\n public static getContainerKey(name: string): string {\r\n // No prefix needed, because ApiEnumMember is the only possible member of an ApiEnum\r\n return name;\r\n }\r\n\r\n /** @override */\r\n public static onDeserializeInto(\r\n options: Partial<IApiEnumMemberOptions>,\r\n context: DeserializerContext,\r\n jsonObject: IApiEnumMemberJson\r\n ): void {\r\n super.onDeserializeInto(options, context, jsonObject);\r\n\r\n options.initializerTokenRange = jsonObject.initializerTokenRange;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.EnumMember;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiEnumMember.getContainerKey(this.name);\r\n }\r\n\r\n /** @override */\r\n public serializeInto(jsonObject: Partial<IApiEnumMemberJson>): void {\r\n super.serializeInto(jsonObject);\r\n\r\n jsonObject.initializerTokenRange = this.initializerExcerpt.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.Member);\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ApiEnumMember.js","sourceRoot":"","sources":["../../src/model/ApiEnumMember.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAKwD;AAExD,8DAA0G;AAC1G,qEAA8F;AAE9F,yDAA4E;AAkB5E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,aAAc,SAAQ,2BAAY,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC;IAMlF,YAAmB,OAA8B;QAC/C,KAAK,CAAC,OAAO,CAAC,CAAC;QAEf,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAC7E,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,oFAAoF;QACpF,OAAO,IAAI,CAAC;IACd,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAAuC,EACvC,OAA4B,EAC5B,UAA8B;QAE9B,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,OAAO,CAAC,qBAAqB,GAAG,UAAU,CAAC,qBAAqB,CAAC;IACnE,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,qCAA8B;IAChC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,aAAa,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClD,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,UAAuC;QAC1D,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEhC,UAAU,CAAC,qBAAqB,GAAG,IAAI,CAAC,kBAAkB,CAAC,UAAU,CAAC;IACxE,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,uBAAgB,CAAC;IACjC,CAAC;CACF;AApDD,sCAoDC","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 { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\r\nimport { Excerpt, IExcerptTokenRange } from '../mixins/Excerpt';\r\nimport { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\nimport { DeserializerContext } from './DeserializerContext';\r\n\r\n/**\r\n * Constructor options for {@link ApiEnumMember}.\r\n * @public\r\n */\r\nexport interface IApiEnumMemberOptions\r\n extends IApiNameMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiDeclaredItemOptions {\r\n initializerTokenRange: IExcerptTokenRange;\r\n}\r\n\r\nexport interface IApiEnumMemberJson extends IApiDeclaredItemJson {\r\n initializerTokenRange: IExcerptTokenRange;\r\n}\r\n\r\n/**\r\n * Represents a member of a TypeScript enum 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 * `ApiEnumMember` represents an enum member such as `Small = 100` in the example below:\r\n *\r\n * ```ts\r\n * export enum FontSizes {\r\n * Small = 100,\r\n * Medium = 200,\r\n * Large = 300\r\n * }\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class ApiEnumMember extends ApiNameMixin(ApiReleaseTagMixin(ApiDeclaredItem)) {\r\n /**\r\n * An {@link Excerpt} that describes the value of the enum member.\r\n */\r\n public readonly initializerExcerpt: Excerpt;\r\n\r\n public constructor(options: IApiEnumMemberOptions) {\r\n super(options);\r\n\r\n this.initializerExcerpt = this.buildExcerpt(options.initializerTokenRange);\r\n }\r\n\r\n public static getContainerKey(name: string): string {\r\n // No prefix needed, because ApiEnumMember is the only possible member of an ApiEnum\r\n return name;\r\n }\r\n\r\n /** @override */\r\n public static onDeserializeInto(\r\n options: Partial<IApiEnumMemberOptions>,\r\n context: DeserializerContext,\r\n jsonObject: IApiEnumMemberJson\r\n ): void {\r\n super.onDeserializeInto(options, context, jsonObject);\r\n\r\n options.initializerTokenRange = jsonObject.initializerTokenRange;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.EnumMember;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiEnumMember.getContainerKey(this.name);\r\n }\r\n\r\n /** @override */\r\n public serializeInto(jsonObject: Partial<IApiEnumMemberJson>): void {\r\n super.serializeInto(jsonObject);\r\n\r\n jsonObject.initializerTokenRange = this.initializerExcerpt.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.Member);\r\n }\r\n}\r\n"]}
@@ -38,9 +38,9 @@ export declare class ApiFunction extends ApiFunction_base {
38
38
  constructor(options: IApiFunctionOptions);
39
39
  static getContainerKey(name: string, overloadIndex: number): string;
40
40
  /** @override */
41
- readonly kind: ApiItemKind;
41
+ get kind(): ApiItemKind;
42
42
  /** @override */
43
- readonly containerKey: string;
43
+ get containerKey(): string;
44
44
  /** @beta @override */
45
45
  buildCanonicalReference(): DeclarationReference;
46
46
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ApiFunction.d.ts","sourceRoot":"","sources":["../../src/model/ApiFunction.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,oBAAoB,EAIrB,MAAM,gDAAgD,CAAC;AACxD,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,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EACL,iCAAiC,EACjC,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,mBACf,SAAQ,oBAAoB,EAC1B,iCAAiC,EACjC,6BAA6B,EAC7B,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,WAAY,SAAQ,gBAEhC;gBACoB,OAAO,EAAE,mBAAmB;WAIjC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM;IAI1E,gBAAgB;aACL,IAAI,EAAI,WAAW;IAI9B,gBAAgB;aACL,YAAY,EAAI,MAAM;IAIjC,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAOvD"}
1
+ {"version":3,"file":"ApiFunction.d.ts","sourceRoot":"","sources":["../../src/model/ApiFunction.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,oBAAoB,EAIrB,MAAM,gDAAgD,CAAC;AACxD,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,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EACL,iCAAiC,EACjC,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,mBACf,SAAQ,oBAAoB,EAC1B,iCAAiC,EACjC,6BAA6B,EAC7B,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,WAAY,SAAQ,gBAEhC;gBACoB,OAAO,EAAE,mBAAmB;WAIjC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM;IAI1E,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.ApiFunction = 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":"ApiFunction.js","sourceRoot":"","sources":["../../src/model/ApiFunction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,yFAKwD;AAExD,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAC9F,qEAA8F;AAC9F,yDAA4E;AAC5E,mFAG6C;AAc7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,WAAY,SAAQ,2BAAY,CAC3C,qDAAyB,CAAC,6CAAqB,CAAC,uCAAkB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CAAC,CAAC,CAC1G;IACC,YAAmB,OAA4B;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,aAAqB;QAC/D,OAAO,GAAG,IAAI,IAAI,yBAAoB,IAAI,aAAa,EAAE,CAAC;IAC5D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,iCAA4B;IAC9B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACpE,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,2BAAkB;aAC7B,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;CACF;AA7BD,kCA6BC","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 { 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 { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\nimport {\r\n IApiTypeParameterListMixinOptions,\r\n ApiTypeParameterListMixin\r\n} from '../mixins/ApiTypeParameterListMixin';\r\n\r\n/**\r\n * Constructor options for {@link ApiFunction}.\r\n * @public\r\n */\r\nexport interface IApiFunctionOptions\r\n extends IApiNameMixinOptions,\r\n IApiTypeParameterListMixinOptions,\r\n IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiReturnTypeMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript function 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 * `ApiFunction` represents a TypeScript declaration such as this example:\r\n *\r\n * ```ts\r\n * export function getAverage(x: number, y: number): number {\r\n * return (x + y) / 2.0;\r\n * }\r\n * ```\r\n *\r\n * Functions are exported by an entry point module or by a namespace. Compare with {@link ApiMethod}, which\r\n * represents a function that is a member of a class.\r\n *\r\n * @public\r\n */\r\nexport class ApiFunction extends ApiNameMixin(\r\n ApiTypeParameterListMixin(ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem))))\r\n) {\r\n public constructor(options: IApiFunctionOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(name: string, overloadIndex: number): string {\r\n return `${name}|${ApiItemKind.Function}|${overloadIndex}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.Function;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiFunction.getContainerKey(this.name, this.overloadIndex);\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.Function)\r\n .withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ApiFunction.js","sourceRoot":"","sources":["../../src/model/ApiFunction.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAKwD;AAExD,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAC9F,qEAA8F;AAC9F,yDAA4E;AAC5E,mFAG6C;AAc7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,WAAY,SAAQ,2BAAY,CAC3C,qDAAyB,CAAC,6CAAqB,CAAC,uCAAkB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CAAC,CAAC,CAC1G;IACC,YAAmB,OAA4B;QAC7C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,aAAqB;QAC/D,OAAO,GAAG,IAAI,IAAI,yBAAoB,IAAI,aAAa,EAAE,CAAC;IAC5D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,iCAA4B;IAC9B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACpE,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,2BAAkB;aAC7B,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;CACF;AA7BD,kCA6BC","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 { 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 { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\nimport {\r\n IApiTypeParameterListMixinOptions,\r\n ApiTypeParameterListMixin\r\n} from '../mixins/ApiTypeParameterListMixin';\r\n\r\n/**\r\n * Constructor options for {@link ApiFunction}.\r\n * @public\r\n */\r\nexport interface IApiFunctionOptions\r\n extends IApiNameMixinOptions,\r\n IApiTypeParameterListMixinOptions,\r\n IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiReturnTypeMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript function 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 * `ApiFunction` represents a TypeScript declaration such as this example:\r\n *\r\n * ```ts\r\n * export function getAverage(x: number, y: number): number {\r\n * return (x + y) / 2.0;\r\n * }\r\n * ```\r\n *\r\n * Functions are exported by an entry point module or by a namespace. Compare with {@link ApiMethod}, which\r\n * represents a function that is a member of a class.\r\n *\r\n * @public\r\n */\r\nexport class ApiFunction extends ApiNameMixin(\r\n ApiTypeParameterListMixin(ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem))))\r\n) {\r\n public constructor(options: IApiFunctionOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(name: string, overloadIndex: number): string {\r\n return `${name}|${ApiItemKind.Function}|${overloadIndex}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.Function;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiFunction.getContainerKey(this.name, this.overloadIndex);\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.Function)\r\n .withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
@@ -37,9 +37,9 @@ export declare class ApiIndexSignature extends ApiIndexSignature_base {
37
37
  constructor(options: IApiIndexSignatureOptions);
38
38
  static getContainerKey(overloadIndex: number): string;
39
39
  /** @override */
40
- readonly kind: ApiItemKind;
40
+ get kind(): ApiItemKind;
41
41
  /** @override */
42
- readonly containerKey: string;
42
+ get containerKey(): string;
43
43
  /** @beta @override */
44
44
  buildCanonicalReference(): DeclarationReference;
45
45
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ApiIndexSignature.d.ts","sourceRoot":"","sources":["../../src/model/ApiIndexSignature.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;AAE9F;;;GAGG;AACH,MAAM,WAAW,yBACf,SAAQ,6BAA6B,EACnC,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,iBAAkB,SAAQ,sBAEtC;gBACoB,OAAO,EAAE,yBAAyB;WAIvC,eAAe,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM;IAI5D,gBAAgB;aACL,IAAI,EAAI,WAAW;IAI9B,gBAAgB;aACL,YAAY,EAAI,MAAM;IAIjC,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAOvD"}
1
+ {"version":3,"file":"ApiIndexSignature.d.ts","sourceRoot":"","sources":["../../src/model/ApiIndexSignature.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;AAE9F;;;GAGG;AACH,MAAM,WAAW,yBACf,SAAQ,6BAA6B,EACnC,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,qBAAa,iBAAkB,SAAQ,sBAEtC;gBACoB,OAAO,EAAE,yBAAyB;WAIvC,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.ApiIndexSignature = 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":"ApiIndexSignature.js","sourceRoot":"","sources":["../../src/model/ApiIndexSignature.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,yFAA2G;AAE3G,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAC9F,qEAA8F;AAY9F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,iBAAkB,SAAQ,6CAAqB,CAC1D,uCAAkB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CACxD;IACC,YAAmB,OAAkC;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,aAAqB;QACjD,OAAO,IAAI,qCAA0B,IAAI,aAAa,EAAE,CAAC;IAC3D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,6CAAkC;IACpC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC/D,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,8BAAwB,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1F,CAAC;CACF;AA7BD,8CA6BC","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\n\r\n/**\r\n * Constructor options for {@link ApiIndexSignature}.\r\n * @public\r\n */\r\nexport interface IApiIndexSignatureOptions\r\n extends IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiReturnTypeMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript index 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 * `ApiIndexSignature` represents a TypeScript declaration such as `[x: number]: number` in this example:\r\n *\r\n * ```ts\r\n * export interface INumberTable {\r\n * // An index signature\r\n * [value: number]: number;\r\n *\r\n * // An overloaded index signature\r\n * [name: string]: number;\r\n * }\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class ApiIndexSignature extends ApiParameterListMixin(\r\n ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem))\r\n) {\r\n public constructor(options: IApiIndexSignatureOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(overloadIndex: number): string {\r\n return `|${ApiItemKind.IndexSignature}|${overloadIndex}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.IndexSignature;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiIndexSignature.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.IndexSignature).withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ApiIndexSignature.js","sourceRoot":"","sources":["../../src/model/ApiIndexSignature.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAA2G;AAE3G,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAC9F,qEAA8F;AAY9F;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAa,iBAAkB,SAAQ,6CAAqB,CAC1D,uCAAkB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CACxD;IACC,YAAmB,OAAkC;QACnD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,aAAqB;QACjD,OAAO,IAAI,qCAA0B,IAAI,aAAa,EAAE,CAAC;IAC3D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,6CAAkC;IACpC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,iBAAiB,CAAC,eAAe,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC/D,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,8BAAwB,CAAC,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1F,CAAC;CACF;AA7BD,8CA6BC","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\n\r\n/**\r\n * Constructor options for {@link ApiIndexSignature}.\r\n * @public\r\n */\r\nexport interface IApiIndexSignatureOptions\r\n extends IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiReturnTypeMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript index 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 * `ApiIndexSignature` represents a TypeScript declaration such as `[x: number]: number` in this example:\r\n *\r\n * ```ts\r\n * export interface INumberTable {\r\n * // An index signature\r\n * [value: number]: number;\r\n *\r\n * // An overloaded index signature\r\n * [name: string]: number;\r\n * }\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class ApiIndexSignature extends ApiParameterListMixin(\r\n ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem))\r\n) {\r\n public constructor(options: IApiIndexSignatureOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(overloadIndex: number): string {\r\n return `|${ApiItemKind.IndexSignature}|${overloadIndex}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.IndexSignature;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiIndexSignature.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.IndexSignature).withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
@@ -43,13 +43,13 @@ export declare class ApiInterface extends ApiInterface_base {
43
43
  /** @override */
44
44
  static onDeserializeInto(options: Partial<IApiInterfaceOptions>, context: DeserializerContext, jsonObject: IApiInterfaceJson): void;
45
45
  /** @override */
46
- readonly kind: ApiItemKind;
46
+ get kind(): ApiItemKind;
47
47
  /** @override */
48
- readonly containerKey: string;
48
+ get containerKey(): string;
49
49
  /**
50
50
  * The list of base interfaces that this interface inherits from using the `extends` keyword.
51
51
  */
52
- readonly extendsTypes: ReadonlyArray<HeritageType>;
52
+ get extendsTypes(): ReadonlyArray<HeritageType>;
53
53
  /** @override */
54
54
  serializeInto(jsonObject: Partial<IApiInterfaceJson>): void;
55
55
  /** @beta @override */
@@ -1 +1 @@
1
- {"version":3,"file":"ApiInterface.d.ts","sourceRoot":"","sources":["../../src/model/ApiInterface.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,oBAAoB,EAIrB,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EACL,qBAAqB,EACrB,6BAA6B,EAC7B,qBAAqB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAC1G,OAAO,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,uBAAuB,EACxB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC/F,OAAO,EACL,iCAAiC,EACjC,8BAA8B,EAC9B,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,oBACf,SAAQ,6BAA6B,EACnC,oBAAoB,EACpB,iCAAiC,EACjC,0BAA0B,EAC1B,uBAAuB;IACzB,kBAAkB,EAAE,kBAAkB,EAAE,CAAC;CAC1C;AAED,MAAM,WAAW,iBACf,SAAQ,qBAAqB,EAC3B,iBAAiB,EACjB,8BAA8B,EAC9B,uBAAuB,EACvB,oBAAoB;IACtB,kBAAkB,EAAE,kBAAkB,EAAE,CAAC;CAC1C;;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,YAAa,SAAQ,iBAEjC;IACC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAsB;gBAEjC,OAAO,EAAE,oBAAoB;WAQlC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAInD,gBAAgB;WACF,iBAAiB,CAC7B,OAAO,EAAE,OAAO,CAAC,oBAAoB,CAAC,EACtC,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,iBAAiB,GAC5B,IAAI;IAMP,gBAAgB;aACL,IAAI,EAAI,WAAW;IAI9B,gBAAgB;aACL,YAAY,EAAI,MAAM;IAIjC;;OAEG;aACQ,YAAY,EAAI,aAAa,CAAC,YAAY,CAAC;IAItD,gBAAgB;IACT,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI;IAMlE,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAMvD"}
1
+ {"version":3,"file":"ApiInterface.d.ts","sourceRoot":"","sources":["../../src/model/ApiInterface.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,oBAAoB,EAIrB,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EACL,qBAAqB,EACrB,6BAA6B,EAC7B,qBAAqB,EACtB,MAAM,iCAAiC,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,uBAAuB,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAC1G,OAAO,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,uBAAuB,EACxB,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,MAAM,mBAAmB,CAAC;AACvD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC/F,OAAO,EACL,iCAAiC,EACjC,8BAA8B,EAC9B,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAC7C,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AAE5D;;;GAGG;AACH,MAAM,WAAW,oBACf,SAAQ,6BAA6B,EACnC,oBAAoB,EACpB,iCAAiC,EACjC,0BAA0B,EAC1B,uBAAuB;IACzB,kBAAkB,EAAE,kBAAkB,EAAE,CAAC;CAC1C;AAED,MAAM,WAAW,iBACf,SAAQ,qBAAqB,EAC3B,iBAAiB,EACjB,8BAA8B,EAC9B,uBAAuB,EACvB,oBAAoB;IACtB,kBAAkB,EAAE,kBAAkB,EAAE,CAAC;CAC1C;;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,qBAAa,YAAa,SAAQ,iBAEjC;IACC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAsB;gBAEjC,OAAO,EAAE,oBAAoB;WAQlC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;IAInD,gBAAgB;WACF,iBAAiB,CAC7B,OAAO,EAAE,OAAO,CAAC,oBAAoB,CAAC,EACtC,OAAO,EAAE,mBAAmB,EAC5B,UAAU,EAAE,iBAAiB,GAC5B,IAAI;IAMP,gBAAgB;IAChB,IAAW,IAAI,IAAI,WAAW,CAE7B;IAED,gBAAgB;IAChB,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED;;OAEG;IACH,IAAW,YAAY,IAAI,aAAa,CAAC,YAAY,CAAC,CAErD;IAED,gBAAgB;IACT,aAAa,CAAC,UAAU,EAAE,OAAO,CAAC,iBAAiB,CAAC,GAAG,IAAI;IAMlE,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAMvD"}
@@ -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.ApiInterface = void 0;
5
6
  const DeclarationReference_1 = require("@microsoft/tsdoc/lib/beta/DeclarationReference");
6
7
  const ApiItemContainerMixin_1 = require("../mixins/ApiItemContainerMixin");
7
8
  const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem");
@@ -1 +1 @@
1
- {"version":3,"file":"ApiInterface.js","sourceRoot":"","sources":["../../src/model/ApiInterface.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,yFAKwD;AAExD,2EAIyC;AACzC,8DAA0G;AAC1G,qEAIsC;AAEtC,iDAA8C;AAC9C,yDAA+F;AAC/F,mFAI6C;AAyB7C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,YAAa,SAAQ,6CAAqB,CACrD,2BAAY,CAAC,qDAAyB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CAAC,CAC7E;IAGC,YAAmB,OAA6B;QAC9C,KAAK,CAAC,OAAO,CAAC,CAAC;QAHA,kBAAa,GAAmB,EAAE,CAAC;QAKlD,KAAK,MAAM,iBAAiB,IAAI,OAAO,CAAC,kBAAkB,EAAE;YAC1D,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,2BAAY,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;SACjF;IACH,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,2BAAqB,EAAE,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAAsC,EACtC,OAA4B,EAC5B,UAA6B;QAE7B,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,OAAO,CAAC,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAC7D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,mCAA6B;IAC/B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,UAAsC;QACzD,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEhC,UAAU,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrF,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,6BAAmB,CAAC;IACpC,CAAC;CACF;AA3DD,oCA2DC","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 {\r\n ApiItemContainerMixin,\r\n IApiItemContainerMixinOptions,\r\n IApiItemContainerJson\r\n} from '../mixins/ApiItemContainerMixin';\r\nimport { ApiDeclaredItem, IApiDeclaredItemOptions, IApiDeclaredItemJson } from '../items/ApiDeclaredItem';\r\nimport {\r\n IApiReleaseTagMixinOptions,\r\n ApiReleaseTagMixin,\r\n IApiReleaseTagMixinJson\r\n} from '../mixins/ApiReleaseTagMixin';\r\nimport { IExcerptTokenRange } from '../mixins/Excerpt';\r\nimport { HeritageType } from './HeritageType';\r\nimport { IApiNameMixinOptions, ApiNameMixin, IApiNameMixinJson } from '../mixins/ApiNameMixin';\r\nimport {\r\n IApiTypeParameterListMixinOptions,\r\n IApiTypeParameterListMixinJson,\r\n ApiTypeParameterListMixin\r\n} from '../mixins/ApiTypeParameterListMixin';\r\nimport { DeserializerContext } from './DeserializerContext';\r\n\r\n/**\r\n * Constructor options for {@link ApiInterface}.\r\n * @public\r\n */\r\nexport interface IApiInterfaceOptions\r\n extends IApiItemContainerMixinOptions,\r\n IApiNameMixinOptions,\r\n IApiTypeParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiDeclaredItemOptions {\r\n extendsTokenRanges: IExcerptTokenRange[];\r\n}\r\n\r\nexport interface IApiInterfaceJson\r\n extends IApiItemContainerJson,\r\n IApiNameMixinJson,\r\n IApiTypeParameterListMixinJson,\r\n IApiReleaseTagMixinJson,\r\n IApiDeclaredItemJson {\r\n extendsTokenRanges: 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 * `ApiInterface` represents a TypeScript declaration such as this:\r\n *\r\n * ```ts\r\n * export interface X extends Y {\r\n * }\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class ApiInterface extends ApiItemContainerMixin(\r\n ApiNameMixin(ApiTypeParameterListMixin(ApiReleaseTagMixin(ApiDeclaredItem)))\r\n) {\r\n private readonly _extendsTypes: HeritageType[] = [];\r\n\r\n public constructor(options: IApiInterfaceOptions) {\r\n super(options);\r\n\r\n for (const extendsTokenRange of options.extendsTokenRanges) {\r\n this._extendsTypes.push(new HeritageType(this.buildExcerpt(extendsTokenRange)));\r\n }\r\n }\r\n\r\n public static getContainerKey(name: string): string {\r\n return `${name}|${ApiItemKind.Interface}`;\r\n }\r\n\r\n /** @override */\r\n public static onDeserializeInto(\r\n options: Partial<IApiInterfaceOptions>,\r\n context: DeserializerContext,\r\n jsonObject: IApiInterfaceJson\r\n ): void {\r\n super.onDeserializeInto(options, context, jsonObject);\r\n\r\n options.extendsTokenRanges = jsonObject.extendsTokenRanges;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.Interface;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiInterface.getContainerKey(this.name);\r\n }\r\n\r\n /**\r\n * The list of base interfaces that this interface inherits from using the `extends` keyword.\r\n */\r\n public get extendsTypes(): ReadonlyArray<HeritageType> {\r\n return this._extendsTypes;\r\n }\r\n\r\n /** @override */\r\n public serializeInto(jsonObject: Partial<IApiInterfaceJson>): void {\r\n super.serializeInto(jsonObject);\r\n\r\n jsonObject.extendsTokenRanges = this.extendsTypes.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.Interface);\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ApiInterface.js","sourceRoot":"","sources":["../../src/model/ApiInterface.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAKwD;AAExD,2EAIyC;AACzC,8DAA0G;AAC1G,qEAIsC;AAEtC,iDAA8C;AAC9C,yDAA+F;AAC/F,mFAI6C;AAyB7C;;;;;;;;;;;;;;;;GAgBG;AACH,MAAa,YAAa,SAAQ,6CAAqB,CACrD,2BAAY,CAAC,qDAAyB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CAAC,CAC7E;IAGC,YAAmB,OAA6B;QAC9C,KAAK,CAAC,OAAO,CAAC,CAAC;QAHA,kBAAa,GAAmB,EAAE,CAAC;QAKlD,KAAK,MAAM,iBAAiB,IAAI,OAAO,CAAC,kBAAkB,EAAE;YAC1D,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,2BAAY,CAAC,IAAI,CAAC,YAAY,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC;SACjF;IACH,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY;QACxC,OAAO,GAAG,IAAI,IAAI,2BAAqB,EAAE,CAAC;IAC5C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,iBAAiB,CAC7B,OAAsC,EACtC,OAA4B,EAC5B,UAA6B;QAE7B,KAAK,CAAC,iBAAiB,CAAC,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;QAEtD,OAAO,CAAC,kBAAkB,GAAG,UAAU,CAAC,kBAAkB,CAAC;IAC7D,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,mCAA6B;IAC/B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,YAAY,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,IAAW,YAAY;QACrB,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;IAED,gBAAgB;IACT,aAAa,CAAC,UAAsC;QACzD,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;QAEhC,UAAU,CAAC,kBAAkB,GAAG,IAAI,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IACrF,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,6BAAmB,CAAC;IACpC,CAAC;CACF;AA3DD,oCA2DC","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 {\r\n ApiItemContainerMixin,\r\n IApiItemContainerMixinOptions,\r\n IApiItemContainerJson\r\n} from '../mixins/ApiItemContainerMixin';\r\nimport { ApiDeclaredItem, IApiDeclaredItemOptions, IApiDeclaredItemJson } from '../items/ApiDeclaredItem';\r\nimport {\r\n IApiReleaseTagMixinOptions,\r\n ApiReleaseTagMixin,\r\n IApiReleaseTagMixinJson\r\n} from '../mixins/ApiReleaseTagMixin';\r\nimport { IExcerptTokenRange } from '../mixins/Excerpt';\r\nimport { HeritageType } from './HeritageType';\r\nimport { IApiNameMixinOptions, ApiNameMixin, IApiNameMixinJson } from '../mixins/ApiNameMixin';\r\nimport {\r\n IApiTypeParameterListMixinOptions,\r\n IApiTypeParameterListMixinJson,\r\n ApiTypeParameterListMixin\r\n} from '../mixins/ApiTypeParameterListMixin';\r\nimport { DeserializerContext } from './DeserializerContext';\r\n\r\n/**\r\n * Constructor options for {@link ApiInterface}.\r\n * @public\r\n */\r\nexport interface IApiInterfaceOptions\r\n extends IApiItemContainerMixinOptions,\r\n IApiNameMixinOptions,\r\n IApiTypeParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiDeclaredItemOptions {\r\n extendsTokenRanges: IExcerptTokenRange[];\r\n}\r\n\r\nexport interface IApiInterfaceJson\r\n extends IApiItemContainerJson,\r\n IApiNameMixinJson,\r\n IApiTypeParameterListMixinJson,\r\n IApiReleaseTagMixinJson,\r\n IApiDeclaredItemJson {\r\n extendsTokenRanges: 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 * `ApiInterface` represents a TypeScript declaration such as this:\r\n *\r\n * ```ts\r\n * export interface X extends Y {\r\n * }\r\n * ```\r\n *\r\n * @public\r\n */\r\nexport class ApiInterface extends ApiItemContainerMixin(\r\n ApiNameMixin(ApiTypeParameterListMixin(ApiReleaseTagMixin(ApiDeclaredItem)))\r\n) {\r\n private readonly _extendsTypes: HeritageType[] = [];\r\n\r\n public constructor(options: IApiInterfaceOptions) {\r\n super(options);\r\n\r\n for (const extendsTokenRange of options.extendsTokenRanges) {\r\n this._extendsTypes.push(new HeritageType(this.buildExcerpt(extendsTokenRange)));\r\n }\r\n }\r\n\r\n public static getContainerKey(name: string): string {\r\n return `${name}|${ApiItemKind.Interface}`;\r\n }\r\n\r\n /** @override */\r\n public static onDeserializeInto(\r\n options: Partial<IApiInterfaceOptions>,\r\n context: DeserializerContext,\r\n jsonObject: IApiInterfaceJson\r\n ): void {\r\n super.onDeserializeInto(options, context, jsonObject);\r\n\r\n options.extendsTokenRanges = jsonObject.extendsTokenRanges;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.Interface;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiInterface.getContainerKey(this.name);\r\n }\r\n\r\n /**\r\n * The list of base interfaces that this interface inherits from using the `extends` keyword.\r\n */\r\n public get extendsTypes(): ReadonlyArray<HeritageType> {\r\n return this._extendsTypes;\r\n }\r\n\r\n /** @override */\r\n public serializeInto(jsonObject: Partial<IApiInterfaceJson>): void {\r\n super.serializeInto(jsonObject);\r\n\r\n jsonObject.extendsTokenRanges = this.extendsTypes.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.Interface);\r\n }\r\n}\r\n"]}
@@ -39,9 +39,9 @@ export declare class ApiMethod extends ApiMethod_base {
39
39
  constructor(options: IApiMethodOptions);
40
40
  static getContainerKey(name: string, isStatic: boolean, overloadIndex: number): string;
41
41
  /** @override */
42
- readonly kind: ApiItemKind;
42
+ get kind(): ApiItemKind;
43
43
  /** @override */
44
- readonly containerKey: string;
44
+ get containerKey(): string;
45
45
  /** @beta @override */
46
46
  buildCanonicalReference(): DeclarationReference;
47
47
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ApiMethod.d.ts","sourceRoot":"","sources":["../../src/model/ApiMethod.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,oBAAoB,EAIrB,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClF,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,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EACL,yBAAyB,EACzB,iCAAiC,EAClC,MAAM,qCAAqC,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,iBACf,SAAQ,oBAAoB,EAC1B,iCAAiC,EACjC,6BAA6B,EAC7B,0BAA0B,EAC1B,0BAA0B,EAC1B,sBAAsB,EACtB,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,SAAU,SAAQ,cAI9B;gBACoB,OAAO,EAAE,iBAAiB;WAI/B,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM;IAQ7F,gBAAgB;aACL,IAAI,EAAI,WAAW;IAI9B,gBAAgB;aACL,YAAY,EAAI,MAAM;IAIjC,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAOvD"}
1
+ {"version":3,"file":"ApiMethod.d.ts","sourceRoot":"","sources":["../../src/model/ApiMethod.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,oBAAoB,EAIrB,MAAM,gDAAgD,CAAC;AACxD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAClF,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,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EACL,yBAAyB,EACzB,iCAAiC,EAClC,MAAM,qCAAqC,CAAC;AAE7C;;;GAGG;AACH,MAAM,WAAW,iBACf,SAAQ,oBAAoB,EAC1B,iCAAiC,EACjC,6BAA6B,EAC7B,0BAA0B,EAC1B,0BAA0B,EAC1B,sBAAsB,EACtB,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,SAAU,SAAQ,cAI9B;gBACoB,OAAO,EAAE,iBAAiB;WAI/B,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM;IAQ7F,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.ApiMethod = void 0;
5
6
  const DeclarationReference_1 = require("@microsoft/tsdoc/lib/beta/DeclarationReference");
6
7
  const ApiStaticMixin_1 = require("../mixins/ApiStaticMixin");
7
8
  const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem");
@@ -1 +1 @@
1
- {"version":3,"file":"ApiMethod.js","sourceRoot":"","sources":["../../src/model/ApiMethod.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,yFAKwD;AAExD,6DAAkF;AAClF,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAC9F,qEAA8F;AAC9F,yDAA4E;AAC5E,mFAG6C;AAe7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,SAAU,SAAQ,2BAAY,CACzC,qDAAyB,CACvB,6CAAqB,CAAC,uCAAkB,CAAC,uCAAkB,CAAC,+BAAc,CAAC,iCAAe,CAAC,CAAC,CAAC,CAAC,CAC/F,CACF;IACC,YAAmB,OAA0B;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,QAAiB,EAAE,aAAqB;QAClF,IAAI,QAAQ,EAAE;YACZ,OAAO,GAAG,IAAI,IAAI,qBAAkB,WAAW,aAAa,EAAE,CAAC;SAChE;aAAM;YACL,OAAO,GAAG,IAAI,IAAI,qBAAkB,aAAa,aAAa,EAAE,CAAC;SAClE;IACH,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,6BAA0B;IAC5B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACjF,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,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,mBAAoB,CAAC,kBAAmB,EAAE,aAAa,CAAC;aACzF,WAAW,uBAAgB;aAC3B,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;CACF;AAnCD,8BAmCC","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 { ApiStaticMixin, IApiStaticMixinOptions } from '../mixins/ApiStaticMixin';\r\nimport { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem';\r\nimport { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\r\nimport { IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';\r\nimport { ApiReturnTypeMixin, IApiReturnTypeMixinOptions } from '../mixins/ApiReturnTypeMixin';\r\nimport { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\nimport {\r\n ApiTypeParameterListMixin,\r\n IApiTypeParameterListMixinOptions\r\n} from '../mixins/ApiTypeParameterListMixin';\r\n\r\n/**\r\n * Constructor options for {@link ApiMethod}.\r\n * @public\r\n */\r\nexport interface IApiMethodOptions\r\n extends IApiNameMixinOptions,\r\n IApiTypeParameterListMixinOptions,\r\n IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiReturnTypeMixinOptions,\r\n IApiStaticMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript member function declaration that belongs to an `ApiClass`.\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 * `ApiMethod` represents a TypeScript declaration such as the `render` member function in this example:\r\n *\r\n * ```ts\r\n * export class Widget {\r\n * public render(): void { }\r\n * }\r\n * ```\r\n *\r\n * Compare with {@link ApiMethodSignature}, which represents a method belonging to an interface.\r\n * For example, a class method can be `static` but an interface method cannot.\r\n *\r\n * @public\r\n */\r\nexport class ApiMethod extends ApiNameMixin(\r\n ApiTypeParameterListMixin(\r\n ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiStaticMixin(ApiDeclaredItem))))\r\n )\r\n) {\r\n public constructor(options: IApiMethodOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(name: string, isStatic: boolean, overloadIndex: number): string {\r\n if (isStatic) {\r\n return `${name}|${ApiItemKind.Method}|static|${overloadIndex}`;\r\n } else {\r\n return `${name}|${ApiItemKind.Method}|instance|${overloadIndex}`;\r\n }\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.Method;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiMethod.getContainerKey(this.name, this.isStatic, this.overloadIndex);\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(this.isStatic ? Navigation.Exports : Navigation.Members, nameComponent)\r\n .withMeaning(Meaning.Member)\r\n .withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ApiMethod.js","sourceRoot":"","sources":["../../src/model/ApiMethod.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAKwD;AAExD,6DAAkF;AAClF,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAC9F,qEAA8F;AAC9F,yDAA4E;AAC5E,mFAG6C;AAe7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,SAAU,SAAQ,2BAAY,CACzC,qDAAyB,CACvB,6CAAqB,CAAC,uCAAkB,CAAC,uCAAkB,CAAC,+BAAc,CAAC,iCAAe,CAAC,CAAC,CAAC,CAAC,CAC/F,CACF;IACC,YAAmB,OAA0B;QAC3C,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,QAAiB,EAAE,aAAqB;QAClF,IAAI,QAAQ,EAAE;YACZ,OAAO,GAAG,IAAI,IAAI,qBAAkB,WAAW,aAAa,EAAE,CAAC;SAChE;aAAM;YACL,OAAO,GAAG,IAAI,IAAI,qBAAkB,aAAa,aAAa,EAAE,CAAC;SAClE;IACH,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,6BAA0B;IAC5B,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,SAAS,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IACjF,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,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,mBAAoB,CAAC,kBAAmB,EAAE,aAAa,CAAC;aACzF,WAAW,uBAAgB;aAC3B,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;CACF;AAnCD,8BAmCC","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 { ApiStaticMixin, IApiStaticMixinOptions } from '../mixins/ApiStaticMixin';\r\nimport { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem';\r\nimport { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin';\r\nimport { IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin';\r\nimport { ApiReturnTypeMixin, IApiReturnTypeMixinOptions } from '../mixins/ApiReturnTypeMixin';\r\nimport { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\nimport {\r\n ApiTypeParameterListMixin,\r\n IApiTypeParameterListMixinOptions\r\n} from '../mixins/ApiTypeParameterListMixin';\r\n\r\n/**\r\n * Constructor options for {@link ApiMethod}.\r\n * @public\r\n */\r\nexport interface IApiMethodOptions\r\n extends IApiNameMixinOptions,\r\n IApiTypeParameterListMixinOptions,\r\n IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiReturnTypeMixinOptions,\r\n IApiStaticMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript member function declaration that belongs to an `ApiClass`.\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 * `ApiMethod` represents a TypeScript declaration such as the `render` member function in this example:\r\n *\r\n * ```ts\r\n * export class Widget {\r\n * public render(): void { }\r\n * }\r\n * ```\r\n *\r\n * Compare with {@link ApiMethodSignature}, which represents a method belonging to an interface.\r\n * For example, a class method can be `static` but an interface method cannot.\r\n *\r\n * @public\r\n */\r\nexport class ApiMethod extends ApiNameMixin(\r\n ApiTypeParameterListMixin(\r\n ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiStaticMixin(ApiDeclaredItem))))\r\n )\r\n) {\r\n public constructor(options: IApiMethodOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(name: string, isStatic: boolean, overloadIndex: number): string {\r\n if (isStatic) {\r\n return `${name}|${ApiItemKind.Method}|static|${overloadIndex}`;\r\n } else {\r\n return `${name}|${ApiItemKind.Method}|instance|${overloadIndex}`;\r\n }\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.Method;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiMethod.getContainerKey(this.name, this.isStatic, this.overloadIndex);\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(this.isStatic ? Navigation.Exports : Navigation.Members, nameComponent)\r\n .withMeaning(Meaning.Member)\r\n .withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
@@ -35,9 +35,9 @@ export declare class ApiMethodSignature extends ApiMethodSignature_base {
35
35
  constructor(options: IApiMethodSignatureOptions);
36
36
  static getContainerKey(name: string, overloadIndex: number): string;
37
37
  /** @override */
38
- readonly kind: ApiItemKind;
38
+ get kind(): ApiItemKind;
39
39
  /** @override */
40
- readonly containerKey: string;
40
+ get containerKey(): string;
41
41
  /** @beta @override */
42
42
  buildCanonicalReference(): DeclarationReference;
43
43
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ApiMethodSignature.d.ts","sourceRoot":"","sources":["../../src/model/ApiMethodSignature.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,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EACL,iCAAiC,EACjC,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAE7C,cAAc;AACd,MAAM,WAAW,0BACf,SAAQ,oBAAoB,EAC1B,iCAAiC,EACjC,6BAA6B,EAC7B,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,kBAAmB,SAAQ,uBAEvC;gBACoB,OAAO,EAAE,0BAA0B;WAIxC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM;IAI1E,gBAAgB;aACL,IAAI,EAAI,WAAW;IAI9B,gBAAgB;aACL,YAAY,EAAI,MAAM;IAIjC,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAOvD"}
1
+ {"version":3,"file":"ApiMethodSignature.d.ts","sourceRoot":"","sources":["../../src/model/ApiMethodSignature.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,MAAM,0BAA0B,CAAC;AACpF,OAAO,EAAE,qBAAqB,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AACvG,OAAO,EAAE,kBAAkB,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,MAAM,8BAA8B,CAAC;AAC9F,OAAO,EAAE,oBAAoB,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AAC5E,OAAO,EACL,iCAAiC,EACjC,yBAAyB,EAC1B,MAAM,qCAAqC,CAAC;AAE7C,cAAc;AACd,MAAM,WAAW,0BACf,SAAQ,oBAAoB,EAC1B,iCAAiC,EACjC,6BAA6B,EAC7B,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB;CAAG;;AAE9B;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,qBAAa,kBAAmB,SAAQ,uBAEvC;gBACoB,OAAO,EAAE,0BAA0B;WAIxC,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM;IAI1E,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.ApiMethodSignature = 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":"ApiMethodSignature.js","sourceRoot":"","sources":["../../src/model/ApiMethodSignature.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;AAE3D,yFAKwD;AAExD,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAC9F,qEAA8F;AAC9F,yDAA4E;AAC5E,mFAG6C;AAW7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,kBAAmB,SAAQ,2BAAY,CAClD,qDAAyB,CAAC,6CAAqB,CAAC,uCAAkB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CAAC,CAAC,CAC1G;IACC,YAAmB,OAAmC;QACpD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,aAAqB;QAC/D,OAAO,GAAG,IAAI,IAAI,uCAA2B,IAAI,aAAa,EAAE,CAAC;IACnE,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,+CAAmC;IACrC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3E,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,uBAAgB;aAC3B,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;CACF;AA7BD,gDA6BC","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 } from '../items/ApiDeclaredItem';\r\nimport { ApiParameterListMixin, IApiParameterListMixinOptions } from '../mixins/ApiParameterListMixin';\r\nimport { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\r\nimport { IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';\r\nimport { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\nimport {\r\n IApiTypeParameterListMixinOptions,\r\n ApiTypeParameterListMixin\r\n} from '../mixins/ApiTypeParameterListMixin';\r\n\r\n/** @public */\r\nexport interface IApiMethodSignatureOptions\r\n extends IApiNameMixinOptions,\r\n IApiTypeParameterListMixinOptions,\r\n IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiReturnTypeMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript member function declaration 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 * `ApiMethodSignature` represents a TypeScript declaration such as the `render` member function in this example:\r\n *\r\n * ```ts\r\n * export interface IWidget {\r\n * render(): void;\r\n * }\r\n * ```\r\n *\r\n * Compare with {@link ApiMethod}, which represents a method belonging to a class.\r\n * For example, a class method can be `static` but an interface method cannot.\r\n *\r\n * @public\r\n */\r\nexport class ApiMethodSignature extends ApiNameMixin(\r\n ApiTypeParameterListMixin(ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem))))\r\n) {\r\n public constructor(options: IApiMethodSignatureOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(name: string, overloadIndex: number): string {\r\n return `${name}|${ApiItemKind.MethodSignature}|${overloadIndex}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.MethodSignature;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiMethodSignature.getContainerKey(this.name, this.overloadIndex);\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.Members, nameComponent)\r\n .withMeaning(Meaning.Member)\r\n .withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"ApiMethodSignature.js","sourceRoot":"","sources":["../../src/model/ApiMethodSignature.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;AAE3D,yFAKwD;AAExD,8DAAoF;AACpF,2EAAuG;AACvG,qEAA8F;AAC9F,qEAA8F;AAC9F,yDAA4E;AAC5E,mFAG6C;AAW7C;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAa,kBAAmB,SAAQ,2BAAY,CAClD,qDAAyB,CAAC,6CAAqB,CAAC,uCAAkB,CAAC,uCAAkB,CAAC,iCAAe,CAAC,CAAC,CAAC,CAAC,CAC1G;IACC,YAAmB,OAAmC;QACpD,KAAK,CAAC,OAAO,CAAC,CAAC;IACjB,CAAC;IAEM,MAAM,CAAC,eAAe,CAAC,IAAY,EAAE,aAAqB;QAC/D,OAAO,GAAG,IAAI,IAAI,uCAA2B,IAAI,aAAa,EAAE,CAAC;IACnE,CAAC;IAED,gBAAgB;IAChB,IAAW,IAAI;QACb,+CAAmC;IACrC,CAAC;IAED,gBAAgB;IAChB,IAAW,YAAY;QACrB,OAAO,kBAAkB,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3E,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,uBAAgB;aAC3B,iBAAiB,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC3C,CAAC;CACF;AA7BD,gDA6BC","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 } from '../items/ApiDeclaredItem';\r\nimport { ApiParameterListMixin, IApiParameterListMixinOptions } from '../mixins/ApiParameterListMixin';\r\nimport { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin';\r\nimport { IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from '../mixins/ApiReturnTypeMixin';\r\nimport { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin';\r\nimport {\r\n IApiTypeParameterListMixinOptions,\r\n ApiTypeParameterListMixin\r\n} from '../mixins/ApiTypeParameterListMixin';\r\n\r\n/** @public */\r\nexport interface IApiMethodSignatureOptions\r\n extends IApiNameMixinOptions,\r\n IApiTypeParameterListMixinOptions,\r\n IApiParameterListMixinOptions,\r\n IApiReleaseTagMixinOptions,\r\n IApiReturnTypeMixinOptions,\r\n IApiDeclaredItemOptions {}\r\n\r\n/**\r\n * Represents a TypeScript member function declaration 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 * `ApiMethodSignature` represents a TypeScript declaration such as the `render` member function in this example:\r\n *\r\n * ```ts\r\n * export interface IWidget {\r\n * render(): void;\r\n * }\r\n * ```\r\n *\r\n * Compare with {@link ApiMethod}, which represents a method belonging to a class.\r\n * For example, a class method can be `static` but an interface method cannot.\r\n *\r\n * @public\r\n */\r\nexport class ApiMethodSignature extends ApiNameMixin(\r\n ApiTypeParameterListMixin(ApiParameterListMixin(ApiReleaseTagMixin(ApiReturnTypeMixin(ApiDeclaredItem))))\r\n) {\r\n public constructor(options: IApiMethodSignatureOptions) {\r\n super(options);\r\n }\r\n\r\n public static getContainerKey(name: string, overloadIndex: number): string {\r\n return `${name}|${ApiItemKind.MethodSignature}|${overloadIndex}`;\r\n }\r\n\r\n /** @override */\r\n public get kind(): ApiItemKind {\r\n return ApiItemKind.MethodSignature;\r\n }\r\n\r\n /** @override */\r\n public get containerKey(): string {\r\n return ApiMethodSignature.getContainerKey(this.name, this.overloadIndex);\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.Members, nameComponent)\r\n .withMeaning(Meaning.Member)\r\n .withOverloadIndex(this.overloadIndex);\r\n }\r\n}\r\n"]}
@@ -52,10 +52,10 @@ export declare class ApiModel extends ApiModel_base {
52
52
  constructor();
53
53
  loadPackage(apiJsonFilename: string): ApiPackage;
54
54
  /** @override */
55
- readonly kind: ApiItemKind;
55
+ get kind(): ApiItemKind;
56
56
  /** @override */
57
- readonly containerKey: string;
58
- readonly packages: ReadonlyArray<ApiPackage>;
57
+ get containerKey(): string;
58
+ get packages(): ReadonlyArray<ApiPackage>;
59
59
  /** @override */
60
60
  addMember(member: ApiPackage): void;
61
61
  /**
@@ -1 +1 @@
1
- {"version":3,"file":"ApiModel.d.ts","sourceRoot":"","sources":["../../src/model/ApiModel.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gDAAgD,CAAC;AACtF,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAA0B,kCAAkC,EAAE,MAAM,0BAA0B,CAAC;AACtG,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,QAAS,SAAQ,aAA8B;IAC1D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IAEnD,OAAO,CAAC,eAAe,CAAkD;IACzE,OAAO,CAAC,6BAA6B,CAA+C;;IAO7E,WAAW,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU;IAMvD,gBAAgB;aACL,IAAI,EAAI,WAAW;IAI9B,gBAAgB;aACL,YAAY,EAAI,MAAM;aAItB,QAAQ,EAAI,aAAa,CAAC,UAAU,CAAC;IAIhD,gBAAgB;IACT,SAAS,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAS1C;;;;;;;;OAQG;IACI,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAsChE,2BAA2B,CAChC,oBAAoB,EAAE,uBAAuB,GAAG,oBAAoB,EACpE,cAAc,EAAE,OAAO,GAAG,SAAS,GAClC,kCAAkC;IAwCrC,OAAO,CAAC,sBAAsB;IAa9B,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAGvD"}
1
+ {"version":3,"file":"ApiModel.d.ts","sourceRoot":"","sources":["../../src/model/ApiModel.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,oBAAoB,EAAE,MAAM,gDAAgD,CAAC;AACtF,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AACxD,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AACxE,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAA0B,kCAAkC,EAAE,MAAM,0BAA0B,CAAC;AACtG,OAAO,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;;AAE3D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,qBAAa,QAAS,SAAQ,aAA8B;IAC1D,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAyB;IAEnD,OAAO,CAAC,eAAe,CAAkD;IACzE,OAAO,CAAC,6BAA6B,CAA+C;;IAO7E,WAAW,CAAC,eAAe,EAAE,MAAM,GAAG,UAAU;IAMvD,gBAAgB;IAChB,IAAW,IAAI,IAAI,WAAW,CAE7B;IAED,gBAAgB;IAChB,IAAW,YAAY,IAAI,MAAM,CAEhC;IAED,IAAW,QAAQ,IAAI,aAAa,CAAC,UAAU,CAAC,CAE/C;IAED,gBAAgB;IACT,SAAS,CAAC,MAAM,EAAE,UAAU,GAAG,IAAI;IAS1C;;;;;;;;OAQG;IACI,mBAAmB,CAAC,WAAW,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAsChE,2BAA2B,CAChC,oBAAoB,EAAE,uBAAuB,GAAG,oBAAoB,EACpE,cAAc,EAAE,OAAO,GAAG,SAAS,GAClC,kCAAkC;IAwCrC,OAAO,CAAC,sBAAsB;IAa9B,sBAAsB;IACf,uBAAuB,IAAI,oBAAoB;CAGvD"}
@@ -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.ApiModel = void 0;
5
6
  const DeclarationReference_1 = require("@microsoft/tsdoc/lib/beta/DeclarationReference");
6
7
  const ApiItem_1 = require("../items/ApiItem");
7
8
  const ApiItemContainerMixin_1 = require("../mixins/ApiItemContainerMixin");