@microsoft/api-extractor - npm Package Compare versions

Comparing version 3.2.0 to 3.2.1

CHANGELOG.json

@@ -5,2 +5,19 @@ {
     {
+      "version": "3.2.1",
+      "tag": "@microsoft/api-extractor_v3.2.1",
+      "date": "Wed, 06 Sep 2017 13:03:42 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Converted IMarkupDocumentationLink to IMarkupApiLink, which exposes the underlying IApiItemReference rather than assuming a particular \"document ID\" model"
+          }
+        ],
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@microsoft/node-core-library\" from `~0.2.4` to `~0.2.5`"
+          }
+        ]
+      }
+    },
+    {
       "version": "3.2.0",
@@ -7,0 +24,0 @@ "tag": "@microsoft/api-extractor_v3.2.0",

CHANGELOG.md

 # Change Log - @microsoft/api-extractor
 
-This log was last generated on Tue, 05 Sep 2017 19:03:56 GMT and should not be manually modified.
+This log was last generated on Wed, 06 Sep 2017 13:03:42 GMT and should not be manually modified.
 
+## 3.2.1
+Wed, 06 Sep 2017 13:03:42 GMT
+
+### Patches
+
+- Converted IMarkupDocumentationLink to IMarkupApiLink, which exposes the underlying IApiItemReference rather than assuming a particular "document ID" model
+
 ## 3.2.0
@@ -6,0 +13,0 @@ Tue, 05 Sep 2017 19:03:56 GMT

lib/api/ApiItem.d.ts

 import { IDocElement } from '../markup/OldMarkup';
 /**
+ * Represents a reference to an ApiItem.
+ * @alpha
+ */
+export interface IApiItemReference {
+    /**
+     * The name of the NPM scope, or an empty string if there is no scope.
+     * @remarks
+     * Example: "@microsoft"
+     */
+    scopeName: string;
+    /**
+     * The name of the NPM package that the API item belongs to, without the NPM scope.
+     * @remarks
+     * Example: "sample-package"
+     */
+    packageName: string;
+    /**
+     * The name of an exported API item, or an empty string.
+     * @remarks
+     * The name does not include any generic parameters or other punctuation.
+     * Example: "SampleClass"
+     */
+    exportName: string;
+    /**
+     * The name of a member of the exported item, or an empty string.
+     * @remarks
+     * The name does not include any parameters or punctuation.
+     * Example: "toString"
+     */
+    memberName: string;
+}
+/**
  * Whether the function is public, private, or protected.
@@ -4,0 +36,0 @@ * @alpha

lib/markup/MarkupElement.d.ts

@@ -0,1 +1,2 @@
+import { IApiItemReference } from '../api/ApiItem';
 /**
@@ -52,6 +53,6 @@ * A block of plain text, possibly with simple formatting such as bold or italics.
  */
-export interface IMarkupDocumentationLink {
-    kind: 'doc-link';
+export interface IMarkupApiLink {
+    kind: 'api-link';
     elements: MarkupLinkTextElement[];
-    targetDocId: string;
+    target: IApiItemReference;
 }
@@ -86,3 +87,3 @@ /**
  */
-export declare type MarkupBasicElement = MarkupLinkTextElement | IMarkupDocumentationLink | IMarkupWebLink | IMarkupParagraph | IMarkupLineBreak;
+export declare type MarkupBasicElement = MarkupLinkTextElement | IMarkupApiLink | IMarkupWebLink | IMarkupParagraph | IMarkupLineBreak;
 /**
@@ -89,0 +90,0 @@ * A top-level heading

package.json

 {
   "name": "@microsoft/api-extractor",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "Validate, document, and review the exported API for a TypeScript library",
@@ -30,3 +30,3 @@ "keywords": [
   "dependencies": {
-    "@microsoft/node-core-library": "~0.2.4",
+    "@microsoft/node-core-library": "~0.2.5",
     "@types/es6-collections": "0.5.29",
@@ -33,0 +33,0 @@ "@types/fs-extra": "0.0.37",

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

773124

increased by0.35%

Lines of code

10030

increased by0.5%

Dependency changes

• Updated@microsoft/node-core-library@~0.2.5