@microsoft/api-extractor
Advanced tools
Comparing version 3.2.2 to 3.2.3
@@ -5,2 +5,21 @@ { | ||
{ | ||
"version": "3.2.3", | ||
"tag": "@microsoft/api-extractor_v3.2.3", | ||
"date": "Thu, 07 Sep 2017 13:04:35 GMT", | ||
"comments": { | ||
"patch": [ | ||
{ | ||
"author": "pgonzal <pgonzal@users.noreply.github.com>", | ||
"commit": "a8b0022b8912d6fb07d1e0dd6618f8842ad6e86c", | ||
"comment": "Fix incorrect schema/typings for enum members" | ||
} | ||
], | ||
"dependency": [ | ||
{ | ||
"comment": "Updating dependency \"@microsoft/node-core-library\" from `~0.2.6` to `~0.2.7`" | ||
} | ||
] | ||
} | ||
}, | ||
{ | ||
"version": "3.2.2", | ||
@@ -7,0 +26,0 @@ "tag": "@microsoft/api-extractor_v3.2.2", |
# Change Log - @microsoft/api-extractor | ||
This log was last generated on Thu, 07 Sep 2017 00:11:11 GMT and should not be manually modified. | ||
This log was last generated on Thu, 07 Sep 2017 13:04:35 GMT and should not be manually modified. | ||
## 3.2.3 | ||
Thu, 07 Sep 2017 13:04:35 GMT | ||
### Patches | ||
- Fix incorrect schema/typings for enum members | ||
## 3.2.2 | ||
@@ -6,0 +13,0 @@ Thu, 07 Sep 2017 00:11:11 GMT |
@@ -522,18 +522,3 @@ { | ||
"^[a-zA-Z_]+[a-zA-Z_0-9]*$": { | ||
"type": "object", | ||
"properties": { | ||
"value": { | ||
"description": "The initializer to the enum value", | ||
"type": "string" | ||
}, | ||
"deprecatedMessage": { | ||
"$ref": "#/definitions/docElementCollection" | ||
}, | ||
"summary": { | ||
"$ref": "#/definitions/docElementCollection" | ||
}, | ||
"remarks": { | ||
"$ref": "#/definitions/docElementCollection" | ||
} | ||
} | ||
"$ref": "#/definitions/enumMemberApiItem" | ||
} | ||
@@ -557,2 +542,37 @@ }, | ||
//--------------------------------------------------------------------------------------------- | ||
"enumMemberApiItem": { | ||
"description": "A TypeScript enum member definition", | ||
"type": "object", | ||
"properties": { | ||
"kind": { | ||
"description": "The kind of API definition", | ||
"type": "string", | ||
"enum": [ "enum value" ] | ||
}, | ||
"summary": { | ||
"$ref": "#/definitions/docElementCollection" | ||
}, | ||
"isBeta": { | ||
"description": "Whether the API enum member is beta", | ||
"type": "boolean" | ||
}, | ||
"value": { | ||
"description": "The value of the enum member. This string may be a number, a string literal (including quotation marks), or an empty string (e.g. if the number is an automatically assigned increment)", | ||
"type": "string" | ||
}, | ||
// Optional properties: | ||
"remarks": { | ||
"$ref": "#/definitions/docElementCollection" | ||
}, | ||
"deprecatedMessage": { | ||
"$ref": "#/definitions/docElementCollection" | ||
} | ||
}, | ||
"additionalProperties": false, | ||
"required": [ "kind", "summary", "isBeta" ] | ||
}, | ||
//--------------------------------------------------------------------------------------------- | ||
"interfaceApiItem": { | ||
@@ -559,0 +579,0 @@ "description": "A TypeScript interface definition", |
@@ -40,15 +40,2 @@ import { IDocElement } from '../markup/OldMarkup'; | ||
/** | ||
* The enum value of an IApiEnum. | ||
* | ||
* IApiEnumMember does not extend the IDocITem base class | ||
* because the summary is not required. | ||
* @alpha | ||
*/ | ||
export interface IApiEnumMember { | ||
value: string; | ||
summary?: IDocElement[]; | ||
remarks?: IDocElement[]; | ||
deprecatedMessage?: IDocElement[]; | ||
} | ||
/** | ||
* Parameter Doc item. | ||
@@ -249,2 +236,14 @@ * @alpha | ||
/** | ||
* A member of an IApiEnum. | ||
* | ||
* @alpha | ||
*/ | ||
export interface IApiEnumMember extends IApiBaseDefinition { | ||
/** | ||
* {@inheritdoc IApiBaseDefinition.kind} | ||
*/ | ||
kind: 'enum value'; | ||
value: string; | ||
} | ||
/** | ||
* IApiInterface represents an exported interface. | ||
@@ -319,3 +318,3 @@ * @alpha | ||
*/ | ||
export declare type ApiItem = IApiProperty | ApiMember | IApiFunction | IApiConstructor | IApiClass | IApiEnum | IApiInterface | IApiPackage; | ||
export declare type ApiItem = IApiProperty | ApiMember | IApiFunction | IApiConstructor | IApiClass | IApiEnum | IApiEnumMember | IApiInterface | IApiPackage; | ||
/** | ||
@@ -322,0 +321,0 @@ * Describes a return type and description of the return type |
{ | ||
"name": "@microsoft/api-extractor", | ||
"version": "3.2.2", | ||
"version": "3.2.3", | ||
"description": "Validate, document, and review the exported API for a TypeScript library", | ||
@@ -30,3 +30,3 @@ "keywords": [ | ||
"dependencies": { | ||
"@microsoft/node-core-library": "~0.2.6", | ||
"@microsoft/node-core-library": "~0.2.7", | ||
"@types/es6-collections": "0.5.29", | ||
@@ -33,0 +33,0 @@ "@types/fs-extra": "0.0.37", |
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
775121
10084