@microsoft/api-extractor-model - npm Package Compare versions

Comparing version 7.0.26 to 7.0.27

CHANGELOG.json

@@ -5,2 +5,22 @@ {
     {
+      "version": "7.0.27",
+      "tag": "@microsoft/api-extractor-model_v7.0.27",
+      "date": "Mon, 18 Mar 2019 04:28:43 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Add helper functions for ReleaseTag"
+          },
+          {
+            "comment": "Export IApiItemConstructor to eliminate the ae-forgotten-export warning"
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@microsoft/node-core-library\" from `3.12.0` to `3.12.1`"
+          }
+        ]
+      }
+    },
+    {
       "version": "7.0.26",
@@ -7,0 +27,0 @@ "tag": "@microsoft/api-extractor-model_v7.0.26",

CHANGELOG.md

 # Change Log - @microsoft/api-extractor-model
 
-This log was last generated on Wed, 13 Mar 2019 19:13:14 GMT and should not be manually modified.
+This log was last generated on Mon, 18 Mar 2019 04:28:43 GMT and should not be manually modified.
 
+## 7.0.27
+Mon, 18 Mar 2019 04:28:43 GMT
+
+### Patches
+
+- Add helper functions for ReleaseTag
+- Export IApiItemConstructor to eliminate the ae-forgotten-export warning
+
 ## 7.0.26
@@ -6,0 +14,0 @@ Wed, 13 Mar 2019 19:13:14 GMT

dist/rollup.d.ts

@@ -1296,2 +1296,4 @@ /**
 /**
+ * This abstraction is used by the mixin pattern.
+ * It describes a class constructor.
  * @public
@@ -1486,3 +1488,9 @@ */
 
-declare interface IApiItemConstructor extends Constructor<ApiItem>, PropertiesOf<typeof ApiItem> {
+/**
+ * This abstraction is used by the mixin pattern.
+ * It describes a class type that inherits from {@link ApiItem}.
+ *
+ * @public
+ */
+export declare interface IApiItemConstructor extends Constructor<ApiItem>, PropertiesOf<typeof ApiItem> {
 }
@@ -1727,2 +1735,5 @@
 /**
+ * This abstraction is used by the mixin pattern.
+ * It describes the "static side" of a class.
+ *
  * @public
@@ -1777,2 +1788,25 @@ */
 
+/**
+ * Helper functions for working with the `ReleaseTag` enum.
+ * @public
+ */
+export declare namespace ReleaseTag {
+    /**
+     * Returns the TSDoc tag name for a `ReleaseTag` value.
+     *
+     * @remarks
+     * For example, `getTagName(ReleaseTag.Internal)` would return the string `@internal`.
+     */
+    export function getTagName(releaseTag: ReleaseTag): string;
+    /**
+     * Compares two `ReleaseTag` values. Their values must not be `ReleaseTag.None`.
+     * @returns 0 if `a` and `b` are equal, a positive number if `a` is more public than `b`,
+     * and a negative number if `a` is less public than `b`.
+     * @remarks
+     * For example, `compareReleaseTag(ReleaseTag.Beta, ReleaseTag.Alpha)` will return a positive
+     * number because beta is more public than alpha.
+     */
+    export function compare(a: ReleaseTag, b: ReleaseTag): number;
+}
+
 export { }

dist/tsdoc-metadata.json

@@ -8,5 +8,5 @@ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.0.17"
+      "packageVersion": "7.0.27"
     }
   ]
 }

lib/aedoc/ReleaseTag.d.ts

@@ -43,1 +43,23 @@ /**
 }
+/**
+ * Helper functions for working with the `ReleaseTag` enum.
+ * @public
+ */
+export declare namespace ReleaseTag {
+    /**
+     * Returns the TSDoc tag name for a `ReleaseTag` value.
+     *
+     * @remarks
+     * For example, `getTagName(ReleaseTag.Internal)` would return the string `@internal`.
+     */
+    function getTagName(releaseTag: ReleaseTag): string;
+    /**
+     * Compares two `ReleaseTag` values. Their values must not be `ReleaseTag.None`.
+     * @returns 0 if `a` and `b` are equal, a positive number if `a` is more public than `b`,
+     * and a negative number if `a` is less public than `b`.
+     * @remarks
+     * For example, `compareReleaseTag(ReleaseTag.Beta, ReleaseTag.Alpha)` will return a positive
+     * number because beta is more public than alpha.
+     */
+    function compare(a: ReleaseTag, b: ReleaseTag): number;
+}

lib/aedoc/ReleaseTag.js

@@ -48,2 +48,37 @@ "use strict";
 })(ReleaseTag = exports.ReleaseTag || (exports.ReleaseTag = {}));
+/**
+ * Helper functions for working with the `ReleaseTag` enum.
+ * @public
+ */
+(function (ReleaseTag) {
+    /**
+     * Returns the TSDoc tag name for a `ReleaseTag` value.
+     *
+     * @remarks
+     * For example, `getTagName(ReleaseTag.Internal)` would return the string `@internal`.
+     */
+    function getTagName(releaseTag) {
+        switch (releaseTag) {
+            case ReleaseTag.None: return '(none)';
+            case ReleaseTag.Internal: return '@internal';
+            case ReleaseTag.Alpha: return '@alpha';
+            case ReleaseTag.Beta: return '@beta';
+            case ReleaseTag.Public: return '@public';
+        }
+        throw new Error('Unsupported release tag');
+    }
+    ReleaseTag.getTagName = getTagName;
+    /**
+     * Compares two `ReleaseTag` values. Their values must not be `ReleaseTag.None`.
+     * @returns 0 if `a` and `b` are equal, a positive number if `a` is more public than `b`,
+     * and a negative number if `a` is less public than `b`.
+     * @remarks
+     * For example, `compareReleaseTag(ReleaseTag.Beta, ReleaseTag.Alpha)` will return a positive
+     * number because beta is more public than alpha.
+     */
+    function compare(a, b) {
+        return a - b;
+    }
+    ReleaseTag.compare = compare;
+})(ReleaseTag = exports.ReleaseTag || (exports.ReleaseTag = {}));
 //# sourceMappingURL=ReleaseTag.js.map

lib/index.d.ts

@@ -12,3 +12,3 @@ /**
 export { IApiDocumentedItemOptions, ApiDocumentedItem } from './items/ApiDocumentedItem';
-export { ApiItemKind, IApiItemOptions, ApiItem } from './items/ApiItem';
+export { ApiItemKind, IApiItemOptions, ApiItem, IApiItemConstructor } from './items/ApiItem';
 export { IApiPropertyItemOptions, ApiPropertyItem } from './items/ApiPropertyItem';
@@ -15,0 +15,0 @@ export { IApiParameterListMixinOptions, IApiParameterOptions, ApiParameterListMixin } from './mixins/ApiParameterListMixin';

lib/items/ApiItem.d.ts

@@ -110,3 +110,9 @@ import { Constructor, PropertiesOf } from '../mixins/Mixin';
 }
+/**
+ * This abstraction is used by the mixin pattern.
+ * It describes a class type that inherits from {@link ApiItem}.
+ *
+ * @public
+ */
 export interface IApiItemConstructor extends Constructor<ApiItem>, PropertiesOf<typeof ApiItem> {
 }

lib/mixins/Mixin.d.ts

 /**
+ * This abstraction is used by the mixin pattern.
+ * It describes a class constructor.
  * @public
@@ -6,2 +8,5 @@ */
 /**
+ * This abstraction is used by the mixin pattern.
+ * It describes the "static side" of a class.
+ *
  * @public
@@ -12,2 +17,1 @@ */
 };
-export declare type Mixin<TBase, TMixin> = TBase & Constructor<TMixin>;

package.json

 {
   "name": "@microsoft/api-extractor-model",
-  "version": "7.0.26",
+  "version": "7.0.27",
   "description": "A helper library for loading and saving the .api.json files created by API Extractor",
@@ -20,3 +20,3 @@ "repository": {
   "dependencies": {
-    "@microsoft/node-core-library": "3.12.0",
+    "@microsoft/node-core-library": "3.12.1",
     "@microsoft/tsdoc": "0.12.8",
@@ -26,4 +26,4 @@ "@types/node": "8.5.8"
   "devDependencies": {
-    "@microsoft/node-library-build": "6.0.29",
-    "@microsoft/rush-stack-compiler-3.2": "0.2.2",
+    "@microsoft/node-library-build": "6.0.39",
+    "@microsoft/rush-stack-compiler-3.2": "0.2.12",
     "@types/jest": "23.3.11",
@@ -30,0 +30,0 @@ "gulp": "~3.9.1",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

419256

increased by1.62%

Lines of code

6074

increased by2.02%

Dependency changes

• + Added@microsoft/node-core-library@3.12.1(transitive)

• - Removed@microsoft/node-core-library@3.12.0(transitive)

• Updated@microsoft/node-core-library@3.12.1