ts-type-predicates 1.0.2 → 1.0.6

package/CHANGELOG.md

@@ -3,6 +3,50 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.0.6](https://github.com/bluelovers/ws-ts-type/compare/ts-type-predicates@1.0.5...ts-type-predicates@1.0.6) (2021-12-07)
+
+
+### 🛠　Build System
+
+* use tsdx ([9af901a](https://github.com/bluelovers/ws-ts-type/commit/9af901a02046daf2dbb8a59086fa890757633458))
+
+
+
+
+
+## [1.0.5](https://github.com/bluelovers/ws-ts-type/compare/ts-type-predicates@1.0.4...ts-type-predicates@1.0.5) (2021-07-27)
+
+
+### ✨　Features
+
+* add `ignoreExpression` ([47d3b6b](https://github.com/bluelovers/ws-ts-type/commit/47d3b6bda19a27c5c23cf7ea6f7674358bb8123c))
+
+
+
+
+
+## [1.0.4](https://github.com/bluelovers/ws-ts-type/compare/ts-type-predicates@1.0.3...ts-type-predicates@1.0.4) (2021-07-22)
+
+
+### ✨　Features
+
+* add typeNarrowed ([e780a69](https://github.com/bluelovers/ws-ts-type/commit/e780a6924756090f8f9f13e00c91e67afa7fc6c3))
+
+
+
+
+
+## [1.0.3](https://github.com/bluelovers/ws-ts-type/compare/ts-type-predicates@1.0.2...ts-type-predicates@1.0.3) (2020-06-17)
+
+
+### ✨　Features
+
+* add expression check ([40a5a44](https://github.com/bluelovers/ws-ts-type/commit/40a5a44982a8edff21d97bafbe9147bdfcc6ca60))
+
+
+
+
+
 ## [1.0.2](https://github.com/bluelovers/ws-ts-type/compare/ts-type-predicates@1.0.1...ts-type-predicates@1.0.2) (2020-06-17)
 
 

package/dist/index.cjs

@@ -0,0 +1,8 @@
+
+'use strict'
+
+if (process.env.NODE_ENV === 'production') {
+  module.exports = require('./index.cjs.production.min.cjs')
+} else {
+  module.exports = require('./index.cjs.development.cjs')
+}

package/dist/index.cjs.development.cjs

@@ -0,0 +1,43 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var assert = require('assert');
+
+function typePredicates(actual, expression = true, message, ignoreExpression) {
+  var _expression;
+
+  (_expression = expression) !== null && _expression !== void 0 ? _expression : expression = true;
+
+  if (typeof expression === 'function') {
+    expression = !!expression(actual);
+  }
+
+  if (expression !== true && ignoreExpression !== true) {
+    throw new assert.AssertionError({
+      message: message !== null && message !== void 0 ? message : `actual ${actual} not as expected`,
+      actual,
+      expected: expression
+    });
+  }
+}
+function typeNarrowed(actual, expression = true, message) {
+  var _expression2;
+
+  (_expression2 = expression) !== null && _expression2 !== void 0 ? _expression2 : expression = true;
+
+  if (typeof expression === 'function') {
+    expression = !!expression(actual);
+  }
+
+  if (expression !== true) {
+    expression = false;
+  }
+
+  return expression;
+}
+
+exports["default"] = typePredicates;
+exports.typeNarrowed = typeNarrowed;
+exports.typePredicates = typePredicates;
+//# sourceMappingURL=index.cjs.development.cjs.map

package/dist/index.cjs.development.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.development.cjs","sources":["../src/index.ts"],"sourcesContent":["import { AssertionError } from 'assert';\n\n/**\n * use asserts for make type predicates work\n *\n * @see https://www.typescriptlang.org/docs/handbook/advanced-types.html#using-type-predicates\n * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions\n */\nexport function typePredicates<T, P = any>(actual: T | P, expression : boolean | ((actual: T | P) => any) = true, message?: string, ignoreExpression?: boolean): asserts actual is T\n{\n\texpression ??= true;\n\n\tif (typeof expression === 'function')\n\t{\n\t\texpression = !!expression(actual);\n\t}\n\n\tif (expression !== true && ignoreExpression !== true)\n\t{\n\t\tthrow new AssertionError({\n\t\t\tmessage: message ?? `actual ${actual} not as expected`,\n\t\t\tactual,\n\t\t\texpected: expression,\n\t\t})\n\t}\n}\n\nexport function typeNarrowed<T, P = any>(actual: T | P, expression : boolean | ((actual: T | P) => any) = true, message?: string): actual is T\n{\n\texpression ??= true;\n\n\tif (typeof expression === 'function')\n\t{\n\t\texpression = !!expression(actual);\n\t}\n\n\tif (expression !== true)\n\t{\n\t\texpression = false;\n\t}\n\n\treturn expression\n}\n\nexport default typePredicates;\n"],"names":[],"mappings":";;;;;;;;;;;AAAA,MAAA,OAAA,UAAA,KAAA,UAAA,EAAwC;;;;;;;;;;;;;;;;;aAoCnC,2BAAmB;;;;;;;;;;;;;;;"}

package/dist/index.cjs.production.min.cjs

@@ -0,0 +1,2 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0});var e=require("assert");function t(t,r=!0,o,n){var s;if(null!==(s=r)&&void 0!==s||(r=!0),"function"==typeof r&&(r=!!r(t)),!0!==r&&!0!==n)throw new e.AssertionError({message:null!=o?o:`actual ${t} not as expected`,actual:t,expected:r})}exports.default=t,exports.typeNarrowed=function(e,t=!0,r){var o;return null!==(o=t)&&void 0!==o||(t=!0),"function"==typeof t&&(t=!!t(e)),!0!==t&&(t=!1),t},exports.typePredicates=t;
+//# sourceMappingURL=index.cjs.production.min.cjs.map

package/dist/index.cjs.production.min.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.production.min.cjs","sources":["../src/index.ts"],"sourcesContent":["import { AssertionError } from 'assert';\n\n/**\n * use asserts for make type predicates work\n *\n * @see https://www.typescriptlang.org/docs/handbook/advanced-types.html#using-type-predicates\n * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions\n */\nexport function typePredicates<T, P = any>(actual: T | P, expression : boolean | ((actual: T | P) => any) = true, message?: string, ignoreExpression?: boolean): asserts actual is T\n{\n\texpression ??= true;\n\n\tif (typeof expression === 'function')\n\t{\n\t\texpression = !!expression(actual);\n\t}\n\n\tif (expression !== true && ignoreExpression !== true)\n\t{\n\t\tthrow new AssertionError({\n\t\t\tmessage: message ?? `actual ${actual} not as expected`,\n\t\t\tactual,\n\t\t\texpected: expression,\n\t\t})\n\t}\n}\n\nexport function typeNarrowed<T, P = any>(actual: T | P, expression : boolean | ((actual: T | P) => any) = true, message?: string): actual is T\n{\n\texpression ??= true;\n\n\tif (typeof expression === 'function')\n\t{\n\t\texpression = !!expression(actual);\n\t}\n\n\tif (expression !== true)\n\t{\n\t\texpression = false;\n\t}\n\n\treturn expression\n}\n\nexport default typePredicates;\n"],"names":["expression"],"mappings":"6JAAA,mBAAAA,0PAoCKA"}

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * use asserts for make type predicates work
+ *
+ * @see https://www.typescriptlang.org/docs/handbook/advanced-types.html#using-type-predicates
+ * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions
+ */
+export declare function typePredicates<T, P = any>(actual: T | P, expression?: boolean | ((actual: T | P) => any), message?: string, ignoreExpression?: boolean): asserts actual is T;
+export declare function typeNarrowed<T, P = any>(actual: T | P, expression?: boolean | ((actual: T | P) => any), message?: string): actual is T;
+export default typePredicates;
+
+export {};

package/dist/index.esm.mjs

@@ -0,0 +1,37 @@
+import { AssertionError } from 'assert';
+
+function typePredicates(actual, expression = true, message, ignoreExpression) {
+  var _expression;
+
+  (_expression = expression) !== null && _expression !== void 0 ? _expression : expression = true;
+
+  if (typeof expression === 'function') {
+    expression = !!expression(actual);
+  }
+
+  if (expression !== true && ignoreExpression !== true) {
+    throw new AssertionError({
+      message: message !== null && message !== void 0 ? message : `actual ${actual} not as expected`,
+      actual,
+      expected: expression
+    });
+  }
+}
+function typeNarrowed(actual, expression = true, message) {
+  var _expression2;
+
+  (_expression2 = expression) !== null && _expression2 !== void 0 ? _expression2 : expression = true;
+
+  if (typeof expression === 'function') {
+    expression = !!expression(actual);
+  }
+
+  if (expression !== true) {
+    expression = false;
+  }
+
+  return expression;
+}
+
+export { typePredicates as default, typeNarrowed, typePredicates };
+//# sourceMappingURL=index.esm.mjs.map

package/dist/index.esm.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.mjs","sources":["../src/index.ts"],"sourcesContent":["import { AssertionError } from 'assert';\n\n/**\n * use asserts for make type predicates work\n *\n * @see https://www.typescriptlang.org/docs/handbook/advanced-types.html#using-type-predicates\n * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions\n */\nexport function typePredicates<T, P = any>(actual: T | P, expression : boolean | ((actual: T | P) => any) = true, message?: string, ignoreExpression?: boolean): asserts actual is T\n{\n\texpression ??= true;\n\n\tif (typeof expression === 'function')\n\t{\n\t\texpression = !!expression(actual);\n\t}\n\n\tif (expression !== true && ignoreExpression !== true)\n\t{\n\t\tthrow new AssertionError({\n\t\t\tmessage: message ?? `actual ${actual} not as expected`,\n\t\t\tactual,\n\t\t\texpected: expression,\n\t\t})\n\t}\n}\n\nexport function typeNarrowed<T, P = any>(actual: T | P, expression : boolean | ((actual: T | P) => any) = true, message?: string): actual is T\n{\n\texpression ??= true;\n\n\tif (typeof expression === 'function')\n\t{\n\t\texpression = !!expression(actual);\n\t}\n\n\tif (expression !== true)\n\t{\n\t\texpression = false;\n\t}\n\n\treturn expression\n}\n\nexport default typePredicates;\n"],"names":[],"mappings":";;;;;;;AAAA,MAAA,OAAA,UAAA,KAAA,UAAA,EAAwC;;;;;;;;;;;;;;;;;aAoCnC,2BAAmB;;;;;;;;;;;;;"}

package/package.json

@@ -1,7 +1,34 @@
 {
   "name": "ts-type-predicates",
-  "version": "1.0.2",
+  "version": "1.0.6",
   "description": "use asserts for make type predicates work",
+  "keywords": [
+    ".d.ts",
+    "@types",
+    "declaration",
+    "dev",
+    "develop",
+    "development",
+    "environment",
+    "ide",
+    "interface",
+    "node",
+    "playground",
+    "runtime",
+    "ts",
+    "type",
+    "type-level",
+    "typelevel",
+    "types",
+    "typescript",
+    "typing",
+    "typings",
+    "type-helprt",
+    "toolbox",
+    "toolbelt",
+    "create-by-yarn-tool",
+    "create-by-tsdx"
+  ],
   "homepage": "https://github.com/bluelovers/ws-ts-type/tree/master/packages/ts-type-predicates#readme",
   "bugs": {
     "url": "https://github.com/bluelovers/ws-ts-type/issues"
@@ -12,21 +39,48 @@
   },
   "license": "ISC",
   "author": "bluelovers",
-  "main": "index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.esm.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.esm.mjs",
+  "types": "dist/index.d.ts",
+  "typings": "dist/index.d.ts",
+  "directories": {
+    "test": "test"
+  },
   "scripts": {
     "lint": "ynpx --quiet eslint -- **/*.ts",
     "test": "echo \"Error: no test specified\"",
     "test:jest": "ynpx --quiet jest -- --coverage",
     "test:mocha": "ynpx --quiet -p ts-node -p mocha mocha -- --require ts-node/register \"!(node_modules)/**/*.{test,spec}.{ts,tsx}\"",
-    "prepublishOnly": "yarn run prepublishOnly:check-bin && yarn run test",
+    "posttest": "yarn run build",
+    "build": "yarn run build:tsdx && yarn run build:dts",
+    "build:dts": "ynpx dts-bundle-generator -o ./dist/index.d.ts ./src/index.ts --no-banner & echo build:dts",
+    "build:tsdx": "ynpx @bluelovers/tsdx build --target node --name index",
+    "preversion": "echo preversion && yarn run test",
+    "version": "echo version",
+    "postversion": "echo postversion",
+    "prepublish": "echo prepublish",
+    "prepublishOnly": "echo prepublishOnly",
+    "prepublishOnly_": "yarn run prepublishOnly:check-bin && yarn run test",
     "prepublishOnly:check-bin": "ynpx --quiet @yarn-tool/check-pkg-bin",
     "prepublishOnly:update": "yarn run ncu && yarn run sort-package-json",
+    "publish": "echo publish",
+    "postpublish": "echo postpublish",
+    "postpublishOnly": "echo postpublishOnly",
     "ncu": "ynpx --quiet yarn-tool -- ncu -u",
-    "sort-package-json": "ynpx --quiet yarn-tool -- sort"
+    "sort-package-json": "ynpx --quiet yarn-tool -- sort",
+    "tsc:showConfig": "ynpx get-current-tsconfig -p"
   },
   "devDependencies": {
     "@bluelovers/tsconfig": "*",
     "@types/node": "*"
   },
-  "gitHead": "c68380222740dd03afdf0c62e0306924da729999"
+  "packageManager": "yarn@^1.22.11",
+  "gitHead": "9b8dbcc39d99e2c9a7bac24974950d237197c58e"
 }

package/{index.d.ts → src/index.d.ts}

@@ -4,5 +4,6 @@
  * @see https://www.typescriptlang.org/docs/handbook/advanced-types.html#using-type-predicates
  * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions
  */
-export declare function typePredicates<T, P = any>(actual: T | P, expression?: any | ((actual: T | P) => any), message?: string): asserts actual is T;
+export declare function typePredicates<T, P = any>(actual: T | P, expression?: boolean | ((actual: T | P) => any), message?: string, ignoreExpression?: boolean): asserts actual is T;
+export declare function typeNarrowed<T, P = any>(actual: T | P, expression?: boolean | ((actual: T | P) => any), message?: string): actual is T;
 export default typePredicates;

package/{index.js → src/index.js}

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.typePredicates = void 0;
+exports.typeNarrowed = exports.typePredicates = void 0;
 const assert_1 = require("assert");
 /**
  * use asserts for make type predicates work
@@ -8,19 +8,30 @@ const assert_1 = require("assert");
  * @see https://www.typescriptlang.org/docs/handbook/advanced-types.html#using-type-predicates
  * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions
  */
-function typePredicates(actual, expression = true, message) {
+function typePredicates(actual, expression = true, message, ignoreExpression) {
+    expression !== null && expression !== void 0 ? expression : (expression = true);
     if (typeof expression === 'function') {
-        expression = expression(actual);
+        expression = !!expression(actual);
     }
-    if (!expression) {
+    if (expression !== true && ignoreExpression !== true) {
         throw new assert_1.AssertionError({
             message: message !== null && message !== void 0 ? message : `actual ${actual} not as expected`,
             actual,
             expected: expression,
         });
     }
-    return expression;
 }
 exports.typePredicates = typePredicates;
+function typeNarrowed(actual, expression = true, message) {
+    expression !== null && expression !== void 0 ? expression : (expression = true);
+    if (typeof expression === 'function') {
+        expression = !!expression(actual);
+    }
+    if (expression !== true) {
+        expression = false;
+    }
+    return expression;
+}
+exports.typeNarrowed = typeNarrowed;
 exports.default = typePredicates;
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAAA,mCAAwC;AAExC;;;;;GAKG;AACH,SAAgB,cAAc,CAAa,MAAa,EAAE,aAAkD,IAAI,EAAE,OAAgB,EAAE,gBAA0B;IAE7J,UAAU,aAAV,UAAU,cAAV,UAAU,IAAV,UAAU,GAAK,IAAI,EAAC;IAEpB,IAAI,OAAO,UAAU,KAAK,UAAU,EACpC;QACC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;KAClC;IAED,IAAI,UAAU,KAAK,IAAI,IAAI,gBAAgB,KAAK,IAAI,EACpD;QACC,MAAM,IAAI,uBAAc,CAAC;YACxB,OAAO,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,UAAU,MAAM,kBAAkB;YACtD,MAAM;YACN,QAAQ,EAAE,UAAU;SACpB,CAAC,CAAA;KACF;AACF,CAAC;AAjBD,wCAiBC;AAED,SAAgB,YAAY,CAAa,MAAa,EAAE,aAAkD,IAAI,EAAE,OAAgB;IAE/H,UAAU,aAAV,UAAU,cAAV,UAAU,IAAV,UAAU,GAAK,IAAI,EAAC;IAEpB,IAAI,OAAO,UAAU,KAAK,UAAU,EACpC;QACC,UAAU,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;KAClC;IAED,IAAI,UAAU,KAAK,IAAI,EACvB;QACC,UAAU,GAAG,KAAK,CAAC;KACnB;IAED,OAAO,UAAU,CAAA;AAClB,CAAC;AAfD,oCAeC;AAED,kBAAe,cAAc,CAAC","sourcesContent":["import { AssertionError } from 'assert';\n\n/**\n * use asserts for make type predicates work\n *\n * @see https://www.typescriptlang.org/docs/handbook/advanced-types.html#using-type-predicates\n * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions\n */\nexport function typePredicates<T, P = any>(actual: T | P, expression : boolean | ((actual: T | P) => any) = true, message?: string, ignoreExpression?: boolean): asserts actual is T\n{\n\texpression ??= true;\n\n\tif (typeof expression === 'function')\n\t{\n\t\texpression = !!expression(actual);\n\t}\n\n\tif (expression !== true && ignoreExpression !== true)\n\t{\n\t\tthrow new AssertionError({\n\t\t\tmessage: message ?? `actual ${actual} not as expected`,\n\t\t\tactual,\n\t\t\texpected: expression,\n\t\t})\n\t}\n}\n\nexport function typeNarrowed<T, P = any>(actual: T | P, expression : boolean | ((actual: T | P) => any) = true, message?: string): actual is T\n{\n\texpression ??= true;\n\n\tif (typeof expression === 'function')\n\t{\n\t\texpression = !!expression(actual);\n\t}\n\n\tif (expression !== true)\n\t{\n\t\texpression = false;\n\t}\n\n\treturn expression\n}\n\nexport default typePredicates;\n"]}

package/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":";;;AAAA,mCAAwC;AAExC;;;;;GAKG;AACH,SAAgB,cAAc,CAAa,MAAa,EAAE,aAA8C,IAAI,EAAE,OAAgB;IAE7H,IAAI,OAAO,UAAU,KAAK,UAAU,EACpC;QACC,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;KAChC;IAED,IAAI,CAAC,UAAU,EACf;QACC,MAAM,IAAI,uBAAc,CAAC;YACxB,OAAO,EAAE,OAAO,aAAP,OAAO,cAAP,OAAO,GAAI,UAAU,MAAM,kBAAkB;YACtD,MAAM;YACN,QAAQ,EAAE,UAAU;SACpB,CAAC,CAAA;KACF;IAED,OAAO,UAAU,CAAA;AAClB,CAAC;AAjBD,wCAiBC;AAED,kBAAe,cAAc,CAAC","sourcesContent":["import { AssertionError } from 'assert';\n\n/**\n * use asserts for make type predicates work\n *\n * @see https://www.typescriptlang.org/docs/handbook/advanced-types.html#using-type-predicates\n * @see https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-7.html#assertion-functions\n */\nexport function typePredicates<T, P = any>(actual: T | P, expression : any | ((actual: T | P) => any) = true, message?: string): asserts actual is T\n{\n\tif (typeof expression === 'function')\n\t{\n\t\texpression = expression(actual);\n\t}\n\n\tif (!expression)\n\t{\n\t\tthrow new AssertionError({\n\t\t\tmessage: message ?? `actual ${actual} not as expected`,\n\t\t\tactual,\n\t\t\texpected: expression,\n\t\t})\n\t}\n\n\treturn expression\n}\n\nexport default typePredicates;\n"]}