@microsoft/api-extractor-model
Advanced tools
Comparing version 7.17.3 to 7.18.0
@@ -18,2 +18,3 @@ /** | ||
export { IApiItemContainerMixinOptions, ApiItemContainerMixin } from './mixins/ApiItemContainerMixin'; | ||
export { IApiProtectedMixinOptions, ApiProtectedMixin } from './mixins/ApiProtectedMixin'; | ||
export { IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from './mixins/ApiReleaseTagMixin'; | ||
@@ -24,2 +25,3 @@ export { IApiReturnTypeMixinOptions, ApiReturnTypeMixin } from './mixins/ApiReturnTypeMixin'; | ||
export { IApiOptionalMixinOptions, ApiOptionalMixin } from './mixins/ApiOptionalMixin'; | ||
export { IApiReadonlyMixinOptions, ApiReadonlyMixin } from './mixins/ApiReadonlyMixin'; | ||
export { ExcerptTokenKind, IExcerptTokenRange, IExcerptToken, ExcerptToken, Excerpt } from './mixins/Excerpt'; | ||
@@ -26,0 +28,0 @@ export { Constructor, PropertiesOf } from './mixins/Mixin'; |
@@ -5,3 +5,3 @@ "use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.HeritageType = exports.ApiVariable = exports.TypeParameter = exports.ApiTypeAlias = exports.ApiPropertySignature = exports.ApiProperty = exports.Parameter = exports.ApiPackage = exports.ApiNamespace = exports.ApiModel = exports.ApiMethodSignature = exports.ApiMethod = exports.ApiInterface = exports.ApiIndexSignature = exports.ApiFunction = exports.ApiEnumMember = exports.ApiEnum = exports.ApiEntryPoint = exports.ApiConstructSignature = exports.ApiConstructor = exports.ApiClass = exports.ApiCallSignature = exports.Excerpt = exports.ExcerptToken = exports.ExcerptTokenKind = exports.ApiOptionalMixin = exports.ApiNameMixin = exports.ApiStaticMixin = exports.ApiReturnTypeMixin = exports.ApiReleaseTagMixin = exports.ApiItemContainerMixin = exports.ApiTypeParameterListMixin = exports.ApiParameterListMixin = exports.ApiPropertyItem = exports.ApiItem = exports.ApiItemKind = exports.ApiDocumentedItem = exports.ApiDeclaredItem = exports.ReleaseTag = exports.AedocDefinitions = void 0; | ||
exports.HeritageType = exports.ApiVariable = exports.TypeParameter = exports.ApiTypeAlias = exports.ApiPropertySignature = exports.ApiProperty = exports.Parameter = exports.ApiPackage = exports.ApiNamespace = exports.ApiModel = exports.ApiMethodSignature = exports.ApiMethod = exports.ApiInterface = exports.ApiIndexSignature = exports.ApiFunction = exports.ApiEnumMember = exports.ApiEnum = exports.ApiEntryPoint = exports.ApiConstructSignature = exports.ApiConstructor = exports.ApiClass = exports.ApiCallSignature = exports.Excerpt = exports.ExcerptToken = exports.ExcerptTokenKind = exports.ApiReadonlyMixin = exports.ApiOptionalMixin = exports.ApiNameMixin = exports.ApiStaticMixin = exports.ApiReturnTypeMixin = exports.ApiReleaseTagMixin = exports.ApiProtectedMixin = exports.ApiItemContainerMixin = exports.ApiTypeParameterListMixin = exports.ApiParameterListMixin = exports.ApiPropertyItem = exports.ApiItem = exports.ApiItemKind = exports.ApiDocumentedItem = exports.ApiDeclaredItem = exports.ReleaseTag = exports.AedocDefinitions = void 0; | ||
/** | ||
@@ -36,2 +36,4 @@ * Use this library to read and write *.api.json files as defined by the | ||
Object.defineProperty(exports, "ApiItemContainerMixin", { enumerable: true, get: function () { return ApiItemContainerMixin_1.ApiItemContainerMixin; } }); | ||
var ApiProtectedMixin_1 = require("./mixins/ApiProtectedMixin"); | ||
Object.defineProperty(exports, "ApiProtectedMixin", { enumerable: true, get: function () { return ApiProtectedMixin_1.ApiProtectedMixin; } }); | ||
var ApiReleaseTagMixin_1 = require("./mixins/ApiReleaseTagMixin"); | ||
@@ -47,2 +49,4 @@ Object.defineProperty(exports, "ApiReleaseTagMixin", { enumerable: true, get: function () { return ApiReleaseTagMixin_1.ApiReleaseTagMixin; } }); | ||
Object.defineProperty(exports, "ApiOptionalMixin", { enumerable: true, get: function () { return ApiOptionalMixin_1.ApiOptionalMixin; } }); | ||
var ApiReadonlyMixin_1 = require("./mixins/ApiReadonlyMixin"); | ||
Object.defineProperty(exports, "ApiReadonlyMixin", { enumerable: true, get: function () { return ApiReadonlyMixin_1.ApiReadonlyMixin; } }); | ||
var Excerpt_1 = require("./mixins/Excerpt"); | ||
@@ -49,0 +53,0 @@ Object.defineProperty(exports, "ExcerptTokenKind", { enumerable: true, get: function () { return Excerpt_1.ExcerptTokenKind; } }); |
@@ -7,2 +7,3 @@ import { Excerpt, IExcerptTokenRange } from '../mixins/Excerpt'; | ||
import { ApiOptionalMixin, IApiOptionalMixinOptions } from '../mixins/ApiOptionalMixin'; | ||
import { ApiReadonlyMixin, IApiReadonlyMixinOptions } from '../mixins/ApiReadonlyMixin'; | ||
/** | ||
@@ -12,3 +13,3 @@ * Constructor options for {@link ApiPropertyItem}. | ||
*/ | ||
export interface IApiPropertyItemOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiOptionalMixinOptions, IApiDeclaredItemOptions { | ||
export interface IApiPropertyItemOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiOptionalMixinOptions, IApiReadonlyMixinOptions, IApiDeclaredItemOptions { | ||
propertyTypeTokenRange: IExcerptTokenRange; | ||
@@ -19,3 +20,3 @@ } | ||
} | ||
declare const ApiPropertyItem_base: typeof ApiDeclaredItem & (new (...args: any[]) => ApiOptionalMixin) & (new (...args: any[]) => ApiReleaseTagMixin) & (new (...args: any[]) => ApiNameMixin); | ||
declare const ApiPropertyItem_base: typeof ApiDeclaredItem & (new (...args: any[]) => ApiReadonlyMixin) & (new (...args: any[]) => ApiOptionalMixin) & (new (...args: any[]) => ApiReleaseTagMixin) & (new (...args: any[]) => ApiNameMixin); | ||
/** | ||
@@ -22,0 +23,0 @@ * The abstract base class for {@link ApiProperty} and {@link ApiPropertySignature}. |
@@ -10,2 +10,3 @@ "use strict"; | ||
const ApiOptionalMixin_1 = require("../mixins/ApiOptionalMixin"); | ||
const ApiReadonlyMixin_1 = require("../mixins/ApiReadonlyMixin"); | ||
/** | ||
@@ -16,3 +17,3 @@ * The abstract base class for {@link ApiProperty} and {@link ApiPropertySignature}. | ||
*/ | ||
class ApiPropertyItem extends (0, ApiNameMixin_1.ApiNameMixin)((0, ApiReleaseTagMixin_1.ApiReleaseTagMixin)((0, ApiOptionalMixin_1.ApiOptionalMixin)(ApiDeclaredItem_1.ApiDeclaredItem))) { | ||
class ApiPropertyItem extends (0, ApiNameMixin_1.ApiNameMixin)((0, ApiReleaseTagMixin_1.ApiReleaseTagMixin)((0, ApiOptionalMixin_1.ApiOptionalMixin)((0, ApiReadonlyMixin_1.ApiReadonlyMixin)(ApiDeclaredItem_1.ApiDeclaredItem)))) { | ||
constructor(options) { | ||
@@ -19,0 +20,0 @@ super(options); |
@@ -5,2 +5,3 @@ import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference'; | ||
import { IApiParameterListMixinOptions, ApiParameterListMixin } from '../mixins/ApiParameterListMixin'; | ||
import { ApiProtectedMixin, IApiProtectedMixinOptions } from '../mixins/ApiProtectedMixin'; | ||
import { IApiReleaseTagMixinOptions, ApiReleaseTagMixin } from '../mixins/ApiReleaseTagMixin'; | ||
@@ -11,5 +12,5 @@ /** | ||
*/ | ||
export interface IApiConstructorOptions extends IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions { | ||
export interface IApiConstructorOptions extends IApiParameterListMixinOptions, IApiProtectedMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions { | ||
} | ||
declare const ApiConstructor_base: typeof ApiDeclaredItem & (new (...args: any[]) => ApiReleaseTagMixin) & (new (...args: any[]) => ApiParameterListMixin); | ||
declare const ApiConstructor_base: typeof ApiDeclaredItem & (new (...args: any[]) => ApiReleaseTagMixin) & (new (...args: any[]) => ApiProtectedMixin) & (new (...args: any[]) => ApiParameterListMixin); | ||
/** | ||
@@ -16,0 +17,0 @@ * Represents a TypeScript class constructor declaration that belongs to an `ApiClass`. |
@@ -10,2 +10,3 @@ "use strict"; | ||
const ApiParameterListMixin_1 = require("../mixins/ApiParameterListMixin"); | ||
const ApiProtectedMixin_1 = require("../mixins/ApiProtectedMixin"); | ||
const ApiReleaseTagMixin_1 = require("../mixins/ApiReleaseTagMixin"); | ||
@@ -39,3 +40,3 @@ /** | ||
*/ | ||
class ApiConstructor extends (0, ApiParameterListMixin_1.ApiParameterListMixin)((0, ApiReleaseTagMixin_1.ApiReleaseTagMixin)(ApiDeclaredItem_1.ApiDeclaredItem)) { | ||
class ApiConstructor extends (0, ApiParameterListMixin_1.ApiParameterListMixin)((0, ApiProtectedMixin_1.ApiProtectedMixin)((0, ApiReleaseTagMixin_1.ApiReleaseTagMixin)(ApiDeclaredItem_1.ApiDeclaredItem))) { | ||
constructor(options) { | ||
@@ -42,0 +43,0 @@ super(options); |
import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference'; | ||
import { ApiItemKind } from '../items/ApiItem'; | ||
import { ApiProtectedMixin, IApiProtectedMixinOptions } from '../mixins/ApiProtectedMixin'; | ||
import { ApiStaticMixin, IApiStaticMixinOptions } from '../mixins/ApiStaticMixin'; | ||
@@ -15,5 +16,5 @@ import { IApiDeclaredItemOptions, ApiDeclaredItem } from '../items/ApiDeclaredItem'; | ||
*/ | ||
export interface IApiMethodOptions extends IApiNameMixinOptions, IApiTypeParameterListMixinOptions, IApiParameterListMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiStaticMixinOptions, IApiOptionalMixinOptions, IApiDeclaredItemOptions { | ||
export interface IApiMethodOptions extends IApiNameMixinOptions, IApiOptionalMixinOptions, IApiParameterListMixinOptions, IApiProtectedMixinOptions, IApiReleaseTagMixinOptions, IApiReturnTypeMixinOptions, IApiStaticMixinOptions, IApiTypeParameterListMixinOptions, IApiDeclaredItemOptions { | ||
} | ||
declare const ApiMethod_base: typeof ApiDeclaredItem & (new (...args: any[]) => ApiOptionalMixin) & (new (...args: any[]) => ApiStaticMixin) & (new (...args: any[]) => ApiReturnTypeMixin) & (new (...args: any[]) => ApiReleaseTagMixin) & (new (...args: any[]) => ApiParameterListMixin) & (new (...args: any[]) => ApiTypeParameterListMixin) & (new (...args: any[]) => ApiNameMixin); | ||
declare const ApiMethod_base: typeof ApiDeclaredItem & (new (...args: any[]) => ApiTypeParameterListMixin) & (new (...args: any[]) => ApiStaticMixin) & (new (...args: any[]) => ApiReturnTypeMixin) & (new (...args: any[]) => ApiReleaseTagMixin) & (new (...args: any[]) => ApiProtectedMixin) & (new (...args: any[]) => ApiParameterListMixin) & (new (...args: any[]) => ApiOptionalMixin) & (new (...args: any[]) => ApiNameMixin); | ||
/** | ||
@@ -20,0 +21,0 @@ * Represents a TypeScript member function declaration that belongs to an `ApiClass`. |
@@ -8,2 +8,3 @@ "use strict"; | ||
const ApiItem_1 = require("../items/ApiItem"); | ||
const ApiProtectedMixin_1 = require("../mixins/ApiProtectedMixin"); | ||
const ApiStaticMixin_1 = require("../mixins/ApiStaticMixin"); | ||
@@ -38,3 +39,3 @@ const ApiDeclaredItem_1 = require("../items/ApiDeclaredItem"); | ||
*/ | ||
class ApiMethod extends (0, ApiNameMixin_1.ApiNameMixin)((0, ApiTypeParameterListMixin_1.ApiTypeParameterListMixin)((0, ApiParameterListMixin_1.ApiParameterListMixin)((0, ApiReleaseTagMixin_1.ApiReleaseTagMixin)((0, ApiReturnTypeMixin_1.ApiReturnTypeMixin)((0, ApiStaticMixin_1.ApiStaticMixin)((0, ApiOptionalMixin_1.ApiOptionalMixin)(ApiDeclaredItem_1.ApiDeclaredItem))))))) { | ||
class ApiMethod extends (0, ApiNameMixin_1.ApiNameMixin)((0, ApiOptionalMixin_1.ApiOptionalMixin)((0, ApiParameterListMixin_1.ApiParameterListMixin)((0, ApiProtectedMixin_1.ApiProtectedMixin)((0, ApiReleaseTagMixin_1.ApiReleaseTagMixin)((0, ApiReturnTypeMixin_1.ApiReturnTypeMixin)((0, ApiStaticMixin_1.ApiStaticMixin)((0, ApiTypeParameterListMixin_1.ApiTypeParameterListMixin)(ApiDeclaredItem_1.ApiDeclaredItem)))))))) { | ||
constructor(options) { | ||
@@ -41,0 +42,0 @@ super(options); |
import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference'; | ||
import { ApiItemKind } from '../items/ApiItem'; | ||
import { ApiProtectedMixin, IApiProtectedMixinOptions } from '../mixins/ApiProtectedMixin'; | ||
import { ApiStaticMixin, IApiStaticMixinOptions } from '../mixins/ApiStaticMixin'; | ||
@@ -9,5 +10,5 @@ import { ApiPropertyItem, IApiPropertyItemOptions } from '../items/ApiPropertyItem'; | ||
*/ | ||
export interface IApiPropertyOptions extends IApiPropertyItemOptions, IApiStaticMixinOptions { | ||
export interface IApiPropertyOptions extends IApiPropertyItemOptions, IApiProtectedMixinOptions, IApiStaticMixinOptions { | ||
} | ||
declare const ApiProperty_base: typeof ApiPropertyItem & (new (...args: any[]) => ApiStaticMixin); | ||
declare const ApiProperty_base: typeof ApiPropertyItem & (new (...args: any[]) => ApiStaticMixin) & (new (...args: any[]) => ApiProtectedMixin); | ||
/** | ||
@@ -14,0 +15,0 @@ * Represents a TypeScript property declaration that belongs to an `ApiClass`. |
@@ -8,2 +8,3 @@ "use strict"; | ||
const ApiItem_1 = require("../items/ApiItem"); | ||
const ApiProtectedMixin_1 = require("../mixins/ApiProtectedMixin"); | ||
const ApiStaticMixin_1 = require("../mixins/ApiStaticMixin"); | ||
@@ -45,3 +46,3 @@ const ApiPropertyItem_1 = require("../items/ApiPropertyItem"); | ||
*/ | ||
class ApiProperty extends (0, ApiStaticMixin_1.ApiStaticMixin)(ApiPropertyItem_1.ApiPropertyItem) { | ||
class ApiProperty extends (0, ApiProtectedMixin_1.ApiProtectedMixin)((0, ApiStaticMixin_1.ApiStaticMixin)(ApiPropertyItem_1.ApiPropertyItem)) { | ||
constructor(options) { | ||
@@ -48,0 +49,0 @@ super(options); |
@@ -5,2 +5,3 @@ import { DeclarationReference } from '@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference'; | ||
import { ApiReleaseTagMixin, IApiReleaseTagMixinOptions } from '../mixins/ApiReleaseTagMixin'; | ||
import { ApiReadonlyMixin, IApiReadonlyMixinOptions } from '../mixins/ApiReadonlyMixin'; | ||
import { IApiNameMixinOptions, ApiNameMixin } from '../mixins/ApiNameMixin'; | ||
@@ -13,3 +14,3 @@ import { IExcerptTokenRange, Excerpt } from '../mixins/Excerpt'; | ||
*/ | ||
export interface IApiVariableOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiDeclaredItemOptions { | ||
export interface IApiVariableOptions extends IApiNameMixinOptions, IApiReleaseTagMixinOptions, IApiReadonlyMixinOptions, IApiDeclaredItemOptions { | ||
variableTypeTokenRange: IExcerptTokenRange; | ||
@@ -20,3 +21,3 @@ } | ||
} | ||
declare const ApiVariable_base: typeof ApiDeclaredItem & (new (...args: any[]) => ApiReleaseTagMixin) & (new (...args: any[]) => ApiNameMixin); | ||
declare const ApiVariable_base: typeof ApiDeclaredItem & (new (...args: any[]) => ApiReadonlyMixin) & (new (...args: any[]) => ApiReleaseTagMixin) & (new (...args: any[]) => ApiNameMixin); | ||
/** | ||
@@ -23,0 +24,0 @@ * Represents a TypeScript variable declaration. |
@@ -10,2 +10,3 @@ "use strict"; | ||
const ApiReleaseTagMixin_1 = require("../mixins/ApiReleaseTagMixin"); | ||
const ApiReadonlyMixin_1 = require("../mixins/ApiReadonlyMixin"); | ||
const ApiNameMixin_1 = require("../mixins/ApiNameMixin"); | ||
@@ -32,3 +33,3 @@ /** | ||
*/ | ||
class ApiVariable extends (0, ApiNameMixin_1.ApiNameMixin)((0, ApiReleaseTagMixin_1.ApiReleaseTagMixin)(ApiDeclaredItem_1.ApiDeclaredItem)) { | ||
class ApiVariable extends (0, ApiNameMixin_1.ApiNameMixin)((0, ApiReleaseTagMixin_1.ApiReleaseTagMixin)((0, ApiReadonlyMixin_1.ApiReadonlyMixin)(ApiDeclaredItem_1.ApiDeclaredItem))) { | ||
constructor(options) { | ||
@@ -35,0 +36,0 @@ super(options); |
@@ -30,3 +30,3 @@ import { TSDocConfiguration } from '@microsoft/tsdoc'; | ||
/** | ||
* Add an `isOptional` field to `IApiParameterOptions` to track whether a function parameter is optional. | ||
* Add an `isOptional` field to `Parameter` and `TypeParameter` to track whether a function parameter is optional. | ||
* | ||
@@ -37,2 +37,12 @@ * When loading older JSON files, the value defaults to `false`. | ||
/** | ||
* Add an `isProtected` field to `ApiConstructor`, `ApiMethod`, and `ApiProperty` to | ||
* track whether a class member has the `protected` modifier. | ||
* | ||
* Add an `isReadonly` field to `ApiProperty`, `ApiPropertySignature`, and `ApiVariable` to | ||
* track whether the item is readonly. | ||
* | ||
* When loading older JSON files, the values default to `false`. | ||
*/ | ||
V_1006 = 1006, | ||
/** | ||
* The current latest .api.json schema version. | ||
@@ -43,3 +53,3 @@ * | ||
*/ | ||
LATEST = 1005, | ||
LATEST = 1006, | ||
/** | ||
@@ -46,0 +56,0 @@ * The oldest .api.json schema version that is still supported for backwards compatibility. |
@@ -35,3 +35,3 @@ "use strict"; | ||
/** | ||
* Add an `isOptional` field to `IApiParameterOptions` to track whether a function parameter is optional. | ||
* Add an `isOptional` field to `Parameter` and `TypeParameter` to track whether a function parameter is optional. | ||
* | ||
@@ -42,2 +42,12 @@ * When loading older JSON files, the value defaults to `false`. | ||
/** | ||
* Add an `isProtected` field to `ApiConstructor`, `ApiMethod`, and `ApiProperty` to | ||
* track whether a class member has the `protected` modifier. | ||
* | ||
* Add an `isReadonly` field to `ApiProperty`, `ApiPropertySignature`, and `ApiVariable` to | ||
* track whether the item is readonly. | ||
* | ||
* When loading older JSON files, the values default to `false`. | ||
*/ | ||
ApiJsonSchemaVersion[ApiJsonSchemaVersion["V_1006"] = 1006] = "V_1006"; | ||
/** | ||
* The current latest .api.json schema version. | ||
@@ -48,3 +58,3 @@ * | ||
*/ | ||
ApiJsonSchemaVersion[ApiJsonSchemaVersion["LATEST"] = 1005] = "LATEST"; | ||
ApiJsonSchemaVersion[ApiJsonSchemaVersion["LATEST"] = 1006] = "LATEST"; | ||
/** | ||
@@ -51,0 +61,0 @@ * The oldest .api.json schema version that is still supported for backwards compatibility. |
{ | ||
"name": "@microsoft/api-extractor-model", | ||
"version": "7.17.3", | ||
"version": "7.18.0", | ||
"description": "A helper library for loading and saving the .api.json files created by API Extractor", | ||
@@ -5,0 +5,0 @@ "repository": { |
Sorry, the diff of this file is too big to display
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
663714
181
8579