@documentalist/client - npm Package Compare versions

Comparing version 2.5.0 to 3.0.0

lib/index.js

@@ -17,9 +17,29 @@ "use strict";
  */
-function __export(m) {
-    for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p];
-}
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-__export(require("./markdown"));
-__export(require("./tags"));
-__export(require("./typescript"));
-__export(require("./utils"));
+/**
+ * This module exports all __client__ interfaces: Documentalist concepts that are meant to be used at runtime
+ * alongside a compiled documentation data file.
+ *
+ * The `Documentalist` class and its plugins are only available at compile-time, but their interfaces are useful
+ * when rendering the data, so they are exposed separately in this module.
+ *
+ * A few utility functions are also provided, including several type guards for `@tags`.
+ */
+__exportStar(require("./compiler"), exports);
+__exportStar(require("./kss"), exports);
+__exportStar(require("./markdown"), exports);
+__exportStar(require("./npm"), exports);
+__exportStar(require("./plugin"), exports);
+__exportStar(require("./tags"), exports);
+__exportStar(require("./typescript"), exports);
+__exportStar(require("./utils"), exports);

lib/markdown.js

@@ -18,2 +18,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isPageNode = void 0;
 /** Type guard for `IPageNode`, useful for its `children` array. */
@@ -20,0 +21,0 @@ function isPageNode(node) {

lib/npm.d.ts

@@ -16,2 +16,5 @@ /**
  */
+/**
+ * NPM package metadata
+ */
 export interface INpmPackage {
@@ -18,0 +21,0 @@ /** Package name. */

lib/tags.js

@@ -18,2 +18,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHeadingTag = exports.isTag = void 0;
 /**
@@ -20,0 +21,0 @@ * Type guard to determine if a `contents` node is an `@tag` statement.

lib/typescript.js

@@ -18,2 +18,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isTsTypeAlias = exports.isTsSignature = exports.isTsProperty = exports.isTsParameter = exports.isTsMethod = exports.isTsInterface = exports.isTsEnumMember = exports.isTsEnum = exports.isTsConstructor = exports.isTsClass = exports.Kind = void 0;
 /** Enumeration describing the various kinds of member supported by this plugin. */
@@ -20,0 +21,0 @@ var Kind;

lib/utils.js

@@ -18,2 +18,3 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.slugify = exports.linkify = void 0;
 /**
@@ -20,0 +21,0 @@ * Splits the `text` string into words and invokes the `callback` for each word that is

package.json

 {
     "name": "@documentalist/client",
-    "version": "2.5.0",
+    "version": "3.0.0",
     "description": "Runtime functions and interfaces used in rendering documentalist data",
@@ -14,7 +14,7 @@ "main": "lib/index.js",
     "devDependencies": {
-        "tslint": "^5.15.0",
-        "typescript": "~3.8.3"
+        "tslint": "^6.1.3",
+        "typescript": "~4.0.3"
     },
     "engines": {
-        "node": ">=8.15.1"
+        "node": ">=10.0.0"
     },
@@ -21,0 +21,0 @@ "repository": {

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

44971

increased by3.43%

Lines of code

861

increased by3.24%

No dependency changes