@magic/types 0.1.28 → 0.1.29

package/README.md

@@ -360,6 +360,10 @@ update dependencies
 - options.strict makes the tests include sort order of objects and array, [1, 2] is [2, 1] if options.strict = true
 - update dependencies
 
-##### 0.1.29 - unreleased
+##### 0.1.29
+
+- change types of is.ln, is.len, is.length and is.count to reflect their type as function with subfunctions
+
+##### 0.1.30 - unreleased
 
 ...

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@magic/types",
-  "version": "0.1.28",
+  "version": "0.1.29",
   "author": "Wizards & Witches",
   "homepage": "https://github.com/magic/types",
   "license": "AGPL-3.0",
@@ -10,8 +10,8 @@
   "type": "module",
   "scripts": {
     "start": "t",
-    "build": "tsc && npm run format && echo 'Types generated in dist/*'",
-    "prepublishOnly": "npm run build",
+    "build": "tsc && npm run format",
+    "prepublishOnly": "npm run test && npm run build",
     "build:docs": "NODE_ENV=production magic build",
     "prod": "NODE_ENV=production magic build serve",
     "clean": "magic clean",

package/src/lib.js

@@ -1,11 +1,68 @@
 import * as fns from './fns.js'
 import * as deep from './deep/index.js'
 
-export const is = {
-  count: fns.getLength,
-  length: fns.getLength,
-  len: fns.getLength,
-  ln: fns.getLength,
+// count, length, len and ln are functions that return the length,
+// but they also have comparison methods attached as properties.
+// This creates enhanced length functions with comparison capabilities.
+
+/**
+ * @typedef {typeof fns.isLengthEqual} LengthComparison
+ */
+
+/**
+ * @typedef {typeof fns.getLength & {
+ *   eq: LengthComparison,
+ *   equal: LengthComparison,
+ *   gt: LengthComparison,
+ *   bigger: LengthComparison,
+ *   biggerequal: LengthComparison,
+ *   greater: LengthComparison,
+ *   greaterequal: LengthComparison,
+ *   gte: LengthComparison,
+ *   gteq: LengthComparison,
+ *   lower: LengthComparison,
+ *   smaller: LengthComparison,
+ *   lt: LengthComparison,
+ *   lowerequal: LengthComparison,
+ *   smallerequal: LengthComparison,
+ *   lte: LengthComparison,
+ *   lteq: LengthComparison
+ * }} EnhancedLengthFunction
+ */
+
+// Create enhanced length functions with comparison methods
+const lengthFunctions = {
+  eq: fns.isLengthEqual,
+  equal: fns.isLengthEqual,
+  gt: fns.isLengthGreater,
+  bigger: fns.isLengthGreater,
+  biggerequal: fns.isLengthGreaterOrEqual,
+  greater: fns.isLengthGreater,
+  greaterequal: fns.isLengthGreaterOrEqual,
+  gte: fns.isLengthGreaterOrEqual,
+  gteq: fns.isLengthGreaterOrEqual,
+  lower: fns.isLengthSmaller,
+  smaller: fns.isLengthSmaller,
+  lt: fns.isLengthSmaller,
+  lowerequal: fns.isLengthSmallerOrEqual,
+  smallerequal: fns.isLengthSmallerOrEqual,
+  lte: fns.isLengthSmallerOrEqual,
+  lteq: fns.isLengthSmallerOrEqual,
+}
+
+// Replace the original length functions with enhanced versions
+const ln = /** @type {EnhancedLengthFunction} */ (fns.getLength)
+Object.assign(ln, lengthFunctions)
+
+const length = ln
+const len = ln
+const count = ln
+
+export const is = /** @type {const} */ {
+  count,
+  length,
+  len,
+  ln,
 
   isError: fns.isError,
   error: fns.isError,
@@ -269,34 +326,4 @@ export const is = {
   ...deep,
 }
 
-// count, length, len and ln are functions that return the length,
-// but they also have comparison methods attached as properties.
-// This creates enhanced length functions with comparison capabilities.
-
-// Create enhanced length functions with comparison methods
-const lengthFunctions = {
-  eq: fns.isLengthEqual,
-  equal: fns.isLengthEqual,
-  gt: fns.isLengthGreater,
-  bigger: fns.isLengthGreater,
-  biggerequal: fns.isLengthGreaterOrEqual,
-  greater: fns.isLengthGreater,
-  greaterequal: fns.isLengthGreaterOrEqual,
-  gte: fns.isLengthGreaterOrEqual,
-  gteq: fns.isLengthGreaterOrEqual,
-  lower: fns.isLengthSmaller,
-  smaller: fns.isLengthSmaller,
-  lt: fns.isLengthSmaller,
-  lowerequal: fns.isLengthSmallerOrEqual,
-  smallerequal: fns.isLengthSmallerOrEqual,
-  lte: fns.isLengthSmallerOrEqual,
-  lteq: fns.isLengthSmallerOrEqual,
-}
-
-// Replace the original length functions with enhanced versions
-is.ln = fns.getLength
-Object.assign(is.ln, lengthFunctions)
-
-is.length = is.len = is.count = is.ln
-
 export default is

package/types/index.d.ts

@@ -183,10 +183,10 @@ export const is: {
       (a: unknown): (c: unknown) => boolean
     }
   }
-  count: (arg: unknown) => number
-  length: (arg: unknown) => number
-  len: (arg: unknown) => number
-  ln: (arg: unknown) => number
+  count: import('./lib.js').EnhancedLengthFunction
+  length: import('./lib.js').EnhancedLengthFunction
+  len: import('./lib.js').EnhancedLengthFunction
+  ln: import('./lib.js').EnhancedLengthFunction
   isError: (e: unknown) => e is Error
   error: (e: unknown) => e is Error
   err: (e: unknown) => e is Error

package/types/lib.d.ts

@@ -181,10 +181,10 @@ export const is: {
       (a: unknown): (c: unknown) => boolean
     }
   }
-  count: (arg: unknown) => number
-  length: (arg: unknown) => number
-  len: (arg: unknown) => number
-  ln: (arg: unknown) => number
+  count: EnhancedLengthFunction
+  length: EnhancedLengthFunction
+  len: EnhancedLengthFunction
+  ln: EnhancedLengthFunction
   isError: (e: unknown) => e is Error
   error: (e: unknown) => e is Error
   err: (e: unknown) => e is Error
@@ -508,3 +508,23 @@ export const is: {
   }
 }
 export default is
+export type LengthComparison = typeof fns.isLengthEqual
+export type EnhancedLengthFunction = typeof fns.getLength & {
+  eq: LengthComparison
+  equal: LengthComparison
+  gt: LengthComparison
+  bigger: LengthComparison
+  biggerequal: LengthComparison
+  greater: LengthComparison
+  greaterequal: LengthComparison
+  gte: LengthComparison
+  gteq: LengthComparison
+  lower: LengthComparison
+  smaller: LengthComparison
+  lt: LengthComparison
+  lowerequal: LengthComparison
+  smallerequal: LengthComparison
+  lte: LengthComparison
+  lteq: LengthComparison
+}
+import * as fns from './fns.js'