@rimbu/base 0.9.4 → 0.10.0

package/dist/main/plain-object.js.map

@@ -1 +1 @@
-{"version":3,"file":"plain-object.js","sourceRoot":"","sources":["../../src/plain-object.ts"],"names":[],"mappings":";;;AAgDA;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,GAAQ;IACjC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,IAAI,KAAK,GAAG;QACZ,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,YAAY,QAAQ,CAAC,CAAC;QACtE,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;QACzB,CAAC,CAAC,MAAM,CAAC,aAAa,IAAI,GAAG,CAAC,CAC/B,CAAC;AACJ,CAAC;AARD,gCAQC;AAED;;;GAGG;AACH,SAAgB,UAAU,CAAC,GAAQ;IACjC,OAAO,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;AAC3E,CAAC;AAFD,gCAEC"}
+{"version":3,"file":"plain-object.js","sourceRoot":"","sources":["../../src/plain-object.ts"],"names":[],"mappings":";;;AAuEA;;;;;;GAMG;AACH,SAAgB,UAAU,CAAC,GAAQ;IACjC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,IAAI,KAAK,GAAG;QACZ,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,YAAY,QAAQ,CAAC,CAAC;QACtE,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;QACzB,CAAC,CAAC,MAAM,CAAC,aAAa,IAAI,GAAG,CAAC,CAC/B,CAAC;AACJ,CAAC;AARD,gCAQC;AAED;;;GAGG;AACH,SAAgB,UAAU,CAAC,GAAQ;IACjC,OAAO,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;AAC3E,CAAC;AAFD,gCAEC"}

package/dist/module/plain-object.js.map

@@ -1 +1 @@
-{"version":3,"file":"plain-object.js","sourceRoot":"","sources":["../../src/plain-object.ts"],"names":[],"mappings":"AAgDA;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,GAAQ;IACjC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,IAAI,KAAK,GAAG;QACZ,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,YAAY,QAAQ,CAAC,CAAC;QACtE,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;QACzB,CAAC,CAAC,MAAM,CAAC,aAAa,IAAI,GAAG,CAAC,CAC/B,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,GAAQ;IACjC,OAAO,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;AAC3E,CAAC"}
+{"version":3,"file":"plain-object.js","sourceRoot":"","sources":["../../src/plain-object.ts"],"names":[],"mappings":"AAuEA;;;;;;GAMG;AACH,MAAM,UAAU,UAAU,CAAC,GAAQ;IACjC,OAAO,CACL,OAAO,GAAG,KAAK,QAAQ;QACvB,IAAI,KAAK,GAAG;QACZ,CAAC,GAAG,CAAC,WAAW,KAAK,MAAM,IAAI,CAAC,CAAC,GAAG,CAAC,WAAW,YAAY,QAAQ,CAAC,CAAC;QACtE,CAAC,CAAC,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;QACzB,CAAC,CAAC,MAAM,CAAC,aAAa,IAAI,GAAG,CAAC,CAC/B,CAAC;AACJ,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CAAC,GAAQ;IACjC,OAAO,GAAG,KAAK,IAAI,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,MAAM,CAAC,QAAQ,IAAI,GAAG,CAAC;AAC3E,CAAC"}

package/dist/types/plain-object.d.ts

@@ -2,12 +2,18 @@
  * Matches any type of function
  */
 export declare type AnyFunc = (...args: any[]) => any;
+/**
+ * Gives true if the given type T is a function, false otherwise.
+ * @typeparam T - the input type
+ */
+export declare type IsAnyFunc<T> = AnyFunc extends T ? true : false;
 /**
  * A predicate type for any record that resolves to true if any of the record
  * properties is a function, false otherwise.
  * This is useful to have a coarse discrimination between pure data objects and class instances.
+ * @typeparam T - the input type
  */
-export declare type IsObjWithoutFunctions<T extends Record<any, any>> = AnyFunc extends T[keyof T] ? false : true;
+export declare type IsObjWithoutFunctions<T> = AnyFunc extends T[keyof T] ? false : true;
 /**
  * A predicate type that resolves to true if the given type satisfies:
  * - it is an object type (not a primitive)
@@ -15,8 +21,9 @@ export declare type IsObjWithoutFunctions<T extends Record<any, any>> = AnyFunc
  * - it is not iterable
  * - it does not have any properties that are functions
  * Otherwise, it resolves to false
+ * @typeparam T - the input type
  */
-export declare type IsPlainObj<T> = T extends null | undefined | number | string | boolean | bigint | symbol | AnyFunc | Iterable<unknown> | AsyncIterable<unknown> ? false : IsObjWithoutFunctions<T>;
+export declare type IsPlainObj<T> = T extends null | undefined | number | string | boolean | bigint | symbol | AnyFunc | Iterable<any> | AsyncIterable<any> ? false : IsObjWithoutFunctions<T>;
 /**
  * Utility type that will only accept objects that are considered 'plain objects' according
  * to the `IsPlainObj` predicate type.
@@ -28,6 +35,18 @@ export declare type PlainObj<T> = IsPlainObj<T> extends true ? T : never;
  * @typeparam T - the value type to test
  */
 export declare type IsAny<T> = 0 extends 1 & T ? true : false;
+/**
+ * Utility type that will only return true if the input type T is a (readonly) array.
+ * @typeparm T - the value type to test
+ */
+export declare type IsArray<T> = T extends readonly any[] ? true : false;
+/**
+ * Utility type to exclude any types that are iterable. Useful in cases where
+ * plain objects are required as inputs but not arrays.
+ */
+export declare type NotIterable = {
+    [Symbol.iterator]?: never;
+};
 /**
  * Companion function to the `IsRecord<T>` type that checks whether the given object is a pure
  * data object.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimbu/base",
-  "version": "0.9.4",
+  "version": "0.10.0",
   "description": "Utilities to implement Rimbu collections",
   "keywords": [
     "array",
@@ -47,11 +47,12 @@
     "format:check": "yarn format:base --check",
     "lint": "eslint src",
     "test": "jest",
+    "test:types": "tsd",
     "typecheck": "tsc"
   },
   "sideEffects": false,
   "dependencies": {
-    "@rimbu/common": "^0.10.2",
+    "@rimbu/common": "^0.10.3",
     "tslib": "^2.4.0"
   },
   "publishConfig": {
@@ -61,5 +62,5 @@
     "index": "src/index.ts",
     "replacer": "../../config/denoify-rimbu-replacer.js"
   },
-  "gitHead": "0d1677b4df9c1b0f1dc337eb38eea7a99ea7fc43"
+  "gitHead": "22ae1cadeb885e7fd30a23bd05c001cda3141e86"
 }

package/src/plain-object.ts

@@ -3,13 +3,21 @@
  */
 export type AnyFunc = (...args: any[]) => any;
 
+/**
+ * Gives true if the given type T is a function, false otherwise.
+ * @typeparam T - the input type
+ */
+export type IsAnyFunc<T> = AnyFunc extends T ? true : false;
+
 /**
  * A predicate type for any record that resolves to true if any of the record
  * properties is a function, false otherwise.
  * This is useful to have a coarse discrimination between pure data objects and class instances.
+ * @typeparam T - the input type
  */
-export type IsObjWithoutFunctions<T extends Record<any, any>> =
-  AnyFunc extends T[keyof T] ? false : true;
+export type IsObjWithoutFunctions<T> = AnyFunc extends T[keyof T]
+  ? false
+  : true;
 
 /**
  * A predicate type that resolves to true if the given type satisfies:
@@ -18,6 +26,7 @@ export type IsObjWithoutFunctions<T extends Record<any, any>> =
  * - it is not iterable
  * - it does not have any properties that are functions
  * Otherwise, it resolves to false
+ * @typeparam T - the input type
  */
 export type IsPlainObj<T> = T extends
   | null
@@ -28,8 +37,8 @@ export type IsPlainObj<T> = T extends
   | bigint
   | symbol
   | AnyFunc
-  | Iterable<unknown>
-  | AsyncIterable<unknown>
+  | Iterable<any>
+  | AsyncIterable<any>
   ? false
   : IsObjWithoutFunctions<T>;
 
@@ -46,6 +55,20 @@ export type PlainObj<T> = IsPlainObj<T> extends true ? T : never;
  */
 export type IsAny<T> = 0 extends 1 & T ? true : false;
 
+/**
+ * Utility type that will only return true if the input type T is a (readonly) array.
+ * @typeparm T - the value type to test
+ */
+export type IsArray<T> = T extends readonly any[] ? true : false;
+
+/**
+ * Utility type to exclude any types that are iterable. Useful in cases where
+ * plain objects are required as inputs but not arrays.
+ */
+export type NotIterable = {
+  [Symbol.iterator]?: never;
+};
+
 /**
  * Companion function to the `IsRecord<T>` type that checks whether the given object is a pure
  * data object.