type-plus 4.16.0 → 4.17.0

package/README.md

@@ -552,6 +552,11 @@ const b2 = brand('y', 1)
 nominalMatch(b1, b2) // false
 ```
 
+## Function Types
+
+- `AnyFunction<P, R>`: a generic type for any function
+- `ExtractFunction<F>`: extract the function signature from a type `F`.
+
 ## Functional Types
 
 - `ChainFn<T>: T`: chain function that returns the input type.

package/cjs/function/ExtractFunction.d.ts

@@ -0,0 +1,6 @@
+import { AnyFunction } from './AnyFunction.js';
+/**
+ * Extract the function signature from a composit type T.
+ */
+export declare type ExtractFunction<T extends AnyFunction> = T extends AnyFunction<infer P, infer R> ? (...args: P) => R : never;
+//# sourceMappingURL=ExtractFunction.d.ts.map

package/cjs/function/ExtractFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtractFunction.d.ts","sourceRoot":"","sources":["../../ts/function/ExtractFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C;;GAEG;AACH,oBAAY,eAAe,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACxF,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,CAAA"}

package/cjs/function/ExtractFunction.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ExtractFunction.js.map

package/cjs/function/ExtractFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtractFunction.js","sourceRoot":"","sources":["../../ts/function/ExtractFunction.ts"],"names":[],"mappings":""}

package/cjs/function/ExtractFunction.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ExtractFunction.spec.d.ts.map

package/cjs/function/ExtractFunction.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtractFunction.spec.d.ts","sourceRoot":"","sources":["../../ts/function/ExtractFunction.spec.ts"],"names":[],"mappings":""}

package/cjs/function/ExtractFunction.spec.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var index_js_1 = require("../index.js");
+it('gets the function itself if it is not composite', function () {
+    index_js_1.isType.equal();
+});
+it('omits other props from the type', function () {
+    index_js_1.isType.equal();
+});
+//# sourceMappingURL=ExtractFunction.spec.js.map

package/cjs/function/ExtractFunction.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtractFunction.spec.js","sourceRoot":"","sources":["../../ts/function/ExtractFunction.spec.ts"],"names":[],"mappings":";;AAAA,wCAAoC;AAGpC,EAAE,CAAC,iDAAiD,EAAE;IAIpD,iBAAM,CAAC,KAAK,EAAc,CAAA;AAC5B,CAAC,CAAC,CAAA;AAEF,EAAE,CAAC,iCAAiC,EAAE;IAIpC,iBAAM,CAAC,KAAK,EAAuB,CAAA;AACrC,CAAC,CAAC,CAAA"}

package/cjs/function/index.d.ts

@@ -1,2 +1,3 @@
 export type { AnyFunction } from './AnyFunction.js';
+export type { ExtractFunction } from './ExtractFunction.js';
 //# sourceMappingURL=index.d.ts.map

package/cjs/function/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../ts/function/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../ts/function/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA"}

package/cjs/index.d.ts

@@ -3,10 +3,10 @@ export * from './array/index.js';
 export * from './assertion/index.js';
 export * from './class/index.js';
 export type { ComposableTypes, NonComposableTypes } from './ComposableTypes.js';
-export * from './function/index.js';
+export type { AnyFunction, ExtractFunction } from './function/index.js';
 export * from './functional/index.js';
-export * from './JSONTypes.js';
-export * from './math/index.js';
+export type { JSONArray, JSONObject, JSONPrimitive, JSONTypes } from './JSONTypes.js';
+export type { Abs, Add, Decrement, Digit, DigitArray, GreaterThan, Increment, IsPositive, IsWhole, Max, Subtract } from './math/index.js';
 export * from './nodejs/index.js';
 export * from './nominal-types/index.js';
 export * from './object/index.js';

package/cjs/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAC7D,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC/E,cAAc,qBAAqB,CAAA;AACnC,cAAc,uBAAuB,CAAA;AACrC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,YAAY,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAClE,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAGlC,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,cAAc,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAC7D,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC/E,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACvE,cAAc,uBAAuB,CAAA;AACrC,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACrF,YAAY,EAAE,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AACzI,cAAc,mBAAmB,CAAA;AACjC,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,YAAY,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAClE,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAGlC,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,cAAc,kBAAkB,CAAA"}

package/cjs/index.js

@@ -23,10 +23,7 @@ Object.defineProperty(exports, "unpartial", { enumerable: true, get: function ()
 __exportStar(require("./array/index.js"), exports);
 __exportStar(require("./assertion/index.js"), exports);
 __exportStar(require("./class/index.js"), exports);
-__exportStar(require("./function/index.js"), exports);
 __exportStar(require("./functional/index.js"), exports);
-__exportStar(require("./JSONTypes.js"), exports);
-__exportStar(require("./math/index.js"), exports);
 __exportStar(require("./nodejs/index.js"), exports);
 __exportStar(require("./nominal-types/index.js"), exports);
 __exportStar(require("./object/index.js"), exports);

package/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,4CAA4C;AAC5C,uCAA6D;AAApD,qGAAA,QAAQ,OAAA;AAAE,yGAAA,YAAY,OAAA;AAAE,sGAAA,SAAS,OAAA;AAC1C,mDAAgC;AAChC,uDAAoC;AACpC,mDAAgC;AAEhC,sDAAmC;AACnC,wDAAqC;AACrC,iDAA8B;AAC9B,kDAA+B;AAC/B,oDAAiC;AACjC,2DAAwC;AACxC,oDAAiC;AACjC,wDAAqC;AAErC,qDAAkC;AAClC,qDAAkC;AAIlC,mDAAgC;AAChC,+BAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,4CAA4C;AAC5C,uCAA6D;AAApD,qGAAA,QAAQ,OAAA;AAAE,yGAAA,YAAY,OAAA;AAAE,sGAAA,SAAS,OAAA;AAC1C,mDAAgC;AAChC,uDAAoC;AACpC,mDAAgC;AAGhC,wDAAqC;AAGrC,oDAAiC;AACjC,2DAAwC;AACxC,oDAAiC;AACjC,wDAAqC;AAErC,qDAAkC;AAClC,qDAAkC;AAIlC,mDAAgC;AAChC,+BAA+B"}

package/esm/function/ExtractFunction.d.ts

@@ -0,0 +1,6 @@
+import { AnyFunction } from './AnyFunction.js';
+/**
+ * Extract the function signature from a composit type T.
+ */
+export declare type ExtractFunction<T extends AnyFunction> = T extends AnyFunction<infer P, infer R> ? (...args: P) => R : never;
+//# sourceMappingURL=ExtractFunction.d.ts.map

package/esm/function/ExtractFunction.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtractFunction.d.ts","sourceRoot":"","sources":["../../ts/function/ExtractFunction.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAE9C;;GAEG;AACH,oBAAY,eAAe,CAAC,CAAC,SAAS,WAAW,IAAI,CAAC,SAAS,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAC,GACxF,CAAC,GAAG,IAAI,EAAE,CAAC,KAAK,CAAC,GAAG,KAAK,CAAA"}

package/esm/function/ExtractFunction.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ExtractFunction.js.map

package/esm/function/ExtractFunction.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtractFunction.js","sourceRoot":"","sources":["../../ts/function/ExtractFunction.ts"],"names":[],"mappings":""}

package/esm/function/ExtractFunction.spec.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=ExtractFunction.spec.d.ts.map

package/esm/function/ExtractFunction.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtractFunction.spec.d.ts","sourceRoot":"","sources":["../../ts/function/ExtractFunction.spec.ts"],"names":[],"mappings":""}

package/esm/function/ExtractFunction.spec.js

@@ -0,0 +1,8 @@
+import { isType } from '../index.js';
+it('gets the function itself if it is not composite', () => {
+    isType.equal();
+});
+it('omits other props from the type', () => {
+    isType.equal();
+});
+//# sourceMappingURL=ExtractFunction.spec.js.map

package/esm/function/ExtractFunction.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ExtractFunction.spec.js","sourceRoot":"","sources":["../../ts/function/ExtractFunction.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AAGpC,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;IAIzD,MAAM,CAAC,KAAK,EAAc,CAAA;AAC5B,CAAC,CAAC,CAAA;AAEF,EAAE,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAIzC,MAAM,CAAC,KAAK,EAAuB,CAAA;AACrC,CAAC,CAAC,CAAA"}

package/esm/function/index.d.ts

@@ -1,2 +1,3 @@
 export type { AnyFunction } from './AnyFunction.js';
+export type { ExtractFunction } from './ExtractFunction.js';
 //# sourceMappingURL=index.d.ts.map

package/esm/function/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../ts/function/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../ts/function/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AACnD,YAAY,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA"}

package/esm/index.d.ts

@@ -3,10 +3,10 @@ export * from './array/index.js';
 export * from './assertion/index.js';
 export * from './class/index.js';
 export type { ComposableTypes, NonComposableTypes } from './ComposableTypes.js';
-export * from './function/index.js';
+export type { AnyFunction, ExtractFunction } from './function/index.js';
 export * from './functional/index.js';
-export * from './JSONTypes.js';
-export * from './math/index.js';
+export type { JSONArray, JSONObject, JSONPrimitive, JSONTypes } from './JSONTypes.js';
+export type { Abs, Add, Decrement, Digit, DigitArray, GreaterThan, Increment, IsPositive, IsWhole, Max, Subtract } from './math/index.js';
 export * from './nodejs/index.js';
 export * from './nominal-types/index.js';
 export * from './object/index.js';

package/esm/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAC7D,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC/E,cAAc,qBAAqB,CAAA;AACnC,cAAc,uBAAuB,CAAA;AACrC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,YAAY,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAClE,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAGlC,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,cAAc,kBAAkB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAC7D,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAChC,YAAY,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAA;AAC/E,YAAY,EAAE,WAAW,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAA;AACvE,cAAc,uBAAuB,CAAA;AACrC,YAAY,EAAE,SAAS,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AACrF,YAAY,EAAE,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,UAAU,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAA;AACzI,cAAc,mBAAmB,CAAA;AACjC,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AACrC,YAAY,EAAE,cAAc,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAA;AAClE,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAGlC,YAAY,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAA;AAC/C,cAAc,kBAAkB,CAAA"}

package/esm/index.js

@@ -3,10 +3,7 @@ export { required, requiredDeep, unpartial } from 'unpartial';
 export * from './array/index.js';
 export * from './assertion/index.js';
 export * from './class/index.js';
-export * from './function/index.js';
 export * from './functional/index.js';
-export * from './JSONTypes.js';
-export * from './math/index.js';
 export * from './nodejs/index.js';
 export * from './nominal-types/index.js';
 export * from './object/index.js';

package/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAC7D,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAEhC,cAAc,qBAAqB,CAAA;AACnC,cAAc,uBAAuB,CAAA;AACrC,cAAc,gBAAgB,CAAA;AAC9B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,mBAAmB,CAAA;AACjC,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AAErC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAIlC,cAAc,kBAAkB,CAAA;AAChC,+BAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../ts/index.ts"],"names":[],"mappings":"AAAA,4CAA4C;AAC5C,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,WAAW,CAAA;AAC7D,cAAc,kBAAkB,CAAA;AAChC,cAAc,sBAAsB,CAAA;AACpC,cAAc,kBAAkB,CAAA;AAGhC,cAAc,uBAAuB,CAAA;AAGrC,cAAc,mBAAmB,CAAA;AACjC,cAAc,0BAA0B,CAAA;AACxC,cAAc,mBAAmB,CAAA;AACjC,cAAc,uBAAuB,CAAA;AAErC,cAAc,oBAAoB,CAAA;AAClC,cAAc,oBAAoB,CAAA;AAIlC,cAAc,kBAAkB,CAAA;AAChC,+BAA+B"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "type-plus",
-  "version": "4.16.0",
+  "version": "4.17.0",
   "description": "Provides additional types for TypeScript.",
   "homepage": "https://github.com/unional/type-plus",
   "bugs": {
@@ -33,11 +33,11 @@
   ],
   "scripts": {
     "build": "run-p build:cjs build:esm build:tslib",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json && ncp package.cjs.json cjs/package.json",
     "build:esm": "tsc -p tsconfig.esm.json",
-    "build:tslib": "tsc -p tsconfig.tslib.json",
+    "build:tslib": "tsc -p tsconfig.tslib.json && ncp package.cjs.json tslib/package.json",
     "build:doc": "typedoc",
-    "clean": "rimraf cjs coverage esm lib libm && mkdir cjs && echo '{\"type\":\"commonjs\"}' > cjs/package.json || true",
+    "clean": "rimraf cjs coverage esm lib libm",
     "coverage": "jest --coverage",
     "depcheck": "depcheck",
     "lint": "eslint --ext=ts,js .",
@@ -74,6 +74,7 @@
     "jest-watch-suspend": "^1.1.2",
     "jest-watch-toggle-config": "^2.0.1",
     "jest-watch-typeahead": "^2.0.0",
+    "ncp": "^2.0.0",
     "npm-run-all": "^4.1.5",
     "pinst": "^3.0.0",
     "rimraf": "^3.0.2",

package/ts/function/ExtractFunction.ts

@@ -0,0 +1,7 @@
+import { AnyFunction } from './AnyFunction.js'
+
+/**
+ * Extract the function signature from a composit type T.
+ */
+export type ExtractFunction<T extends AnyFunction> = T extends AnyFunction<infer P, infer R>
+  ? (...args: P) => R : never

package/ts/function/index.ts

@@ -1 +1,2 @@
 export type { AnyFunction } from './AnyFunction.js'
+export type { ExtractFunction } from './ExtractFunction.js'

package/ts/index.ts

@@ -4,10 +4,10 @@ export * from './array/index.js'
 export * from './assertion/index.js'
 export * from './class/index.js'
 export type { ComposableTypes, NonComposableTypes } from './ComposableTypes.js'
-export * from './function/index.js'
+export type { AnyFunction, ExtractFunction } from './function/index.js'
 export * from './functional/index.js'
-export * from './JSONTypes.js'
-export * from './math/index.js'
+export type { JSONArray, JSONObject, JSONPrimitive, JSONTypes } from './JSONTypes.js'
+export type { Abs, Add, Decrement, Digit, DigitArray, GreaterThan, Increment, IsPositive, IsWhole, Max, Subtract } from './math/index.js'
 export * from './nodejs/index.js'
 export * from './nominal-types/index.js'
 export * from './object/index.js'