@rimbu/base 0.8.2 → 0.9.2

package/README.md

@@ -76,7 +76,7 @@ console.log(arr);
 
 ## Contributing
 
-Feel very welcome to contribute to further improve Rimbu. Please read our [Contributing guide](../../CONTRIBUTING.md).
+Feel very welcome to contribute to further improve Rimbu. Please read our [Contributing guide](https://github.com/rimbu-org/rimbu/blob/main/CONTRIBUTING.md).
 
 ## Contributors
 

package/dist/main/index.js

@@ -2,11 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.RimbuError = exports.Entry = exports.Arr = void 0;
 var tslib_1 = require("tslib");
-var Arr = tslib_1.__importStar(require("./arr"));
-exports.Arr = Arr;
-var Entry = tslib_1.__importStar(require("./entry"));
-exports.Entry = Entry;
-var RimbuError = tslib_1.__importStar(require("./rimbu-error"));
-exports.RimbuError = RimbuError;
+exports.Arr = tslib_1.__importStar(require("./arr"));
+exports.Entry = tslib_1.__importStar(require("./entry"));
+exports.RimbuError = tslib_1.__importStar(require("./rimbu-error"));
+tslib_1.__exportStar(require("./plain-object"), exports);
 tslib_1.__exportStar(require("./internal"), exports);
 //# sourceMappingURL=index.js.map

package/dist/main/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAAA,iDAA6B;AAIpB,kBAAG;AAHZ,qDAAiC;AAGnB,sBAAK;AAFnB,gEAA4C;AAEvB,gCAAU;AAE/B,qDAA2B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;AAAA,qDAA6B;AAC7B,yDAAiC;AACjC,oEAA4C;AAC5C,yDAA+B;AAE/B,qDAA2B"}

package/dist/main/plain-object.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isIterable = exports.isPlainObj = void 0;
+/**
+ * Companion function to the `IsRecord<T>` type that checks whether the given object is a pure
+ * data object.
+ * @param obj - the object to check
+ * @returns true if the given object is a pure data object
+ * @note does not check whether a record's properties are not functions
+ */
+function isPlainObj(obj) {
+    return (typeof obj === 'object' &&
+        null !== obj &&
+        (obj.constructor === Object || !(obj.constructor instanceof Function)) &&
+        !(Symbol.iterator in obj) &&
+        !(Symbol.asyncIterator in obj));
+}
+exports.isPlainObj = isPlainObj;
+/**
+ * Returns true if the given object is Iterable
+ * @param obj - the object to check
+ */
+function isIterable(obj) {
+    return obj !== null && typeof obj === 'object' && Symbol.iterator in obj;
+}
+exports.isIterable = isIterable;
+//# sourceMappingURL=plain-object.js.map

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

@@ -0,0 +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"}

package/dist/module/index.js

@@ -1,6 +1,6 @@
-import * as Arr from './arr';
-import * as Entry from './entry';
-import * as RimbuError from './rimbu-error';
-export { Arr, Entry, RimbuError };
+export * as Arr from './arr';
+export * as Entry from './entry';
+export * as RimbuError from './rimbu-error';
+export * from './plain-object';
 export * from './internal';
 //# sourceMappingURL=index.js.map

package/dist/module/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAE5C,OAAO,EAAE,GAAG,EAAE,KAAK,EAAE,UAAU,EAAE,CAAC;AAElC,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,GAAG,MAAM,OAAO,CAAC;AAC7B,OAAO,KAAK,KAAK,MAAM,SAAS,CAAC;AACjC,OAAO,KAAK,UAAU,MAAM,eAAe,CAAC;AAC5C,cAAc,gBAAgB,CAAC;AAE/B,cAAc,YAAY,CAAC"}

package/dist/module/plain-object.js

@@ -0,0 +1,22 @@
+/**
+ * Companion function to the `IsRecord<T>` type that checks whether the given object is a pure
+ * data object.
+ * @param obj - the object to check
+ * @returns true if the given object is a pure data object
+ * @note does not check whether a record's properties are not functions
+ */
+export function isPlainObj(obj) {
+    return (typeof obj === 'object' &&
+        null !== obj &&
+        (obj.constructor === Object || !(obj.constructor instanceof Function)) &&
+        !(Symbol.iterator in obj) &&
+        !(Symbol.asyncIterator in obj));
+}
+/**
+ * Returns true if the given object is Iterable
+ * @param obj - the object to check
+ */
+export function isIterable(obj) {
+    return obj !== null && typeof obj === 'object' && Symbol.iterator in obj;
+}
+//# sourceMappingURL=plain-object.js.map

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

@@ -0,0 +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"}

package/dist/types/index.d.ts

@@ -1,5 +1,5 @@
-import * as Arr from './arr';
-import * as Entry from './entry';
-import * as RimbuError from './rimbu-error';
-export { Arr, Entry, RimbuError };
+export * as Arr from './arr';
+export * as Entry from './entry';
+export * as RimbuError from './rimbu-error';
+export * from './plain-object';
 export * from './internal';

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

@@ -0,0 +1,43 @@
+/**
+ * Matches any type of function
+ */
+export declare type AnyFunc = (...args: any[]) => any;
+/**
+ * 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.
+ */
+export declare type IsObjWithoutFunctions<T extends Record<any, any>> = 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)
+ * - it is not a function
+ * - it is not iterable
+ * - it does not have any properties that are functions
+ * Otherwise, it resolves to false
+ */
+export declare type IsPlainObj<T> = T extends null | undefined | number | string | boolean | bigint | symbol | AnyFunc | Iterable<unknown> | AsyncIterable<unknown> ? false : IsObjWithoutFunctions<T>;
+/**
+ * Utility type that will only accept objects that are considered 'plain objects' according
+ * to the `IsPlainObj` predicate type.
+ * @typeparam T - the value type to test
+ */
+export declare type PlainObj<T> = IsPlainObj<T> extends true ? T : never;
+/**
+ * Utility type that will only return true if the input type T is equal to `any`.
+ * @typeparam T - the value type to test
+ */
+export declare type IsAny<T> = 0 extends 1 & T ? true : false;
+/**
+ * Companion function to the `IsRecord<T>` type that checks whether the given object is a pure
+ * data object.
+ * @param obj - the object to check
+ * @returns true if the given object is a pure data object
+ * @note does not check whether a record's properties are not functions
+ */
+export declare function isPlainObj(obj: any): boolean;
+/**
+ * Returns true if the given object is Iterable
+ * @param obj - the object to check
+ */
+export declare function isIterable(obj: any): obj is Iterable<unknown>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rimbu/base",
-  "version": "0.8.2",
+  "version": "0.9.2",
   "description": "Utilities to implement Rimbu collections",
   "keywords": [
     "array",
@@ -51,7 +51,7 @@
   },
   "sideEffects": false,
   "dependencies": {
-    "@rimbu/common": "^0.9.2",
+    "@rimbu/common": "^0.10.0",
     "tslib": "^2.4.0"
   },
   "publishConfig": {
@@ -61,5 +61,5 @@
     "index": "src/index.ts",
     "replacer": "../../config/denoify-rimbu-replacer.js"
   },
-  "gitHead": "33dd7ca935f19f513586834a2ce1b1f886352ae7"
+  "gitHead": "4d6b7411c36f599331185b1bc597e58f34954d1a"
 }

package/src/index.ts

@@ -1,7 +1,6 @@
-import * as Arr from './arr';
-import * as Entry from './entry';
-import * as RimbuError from './rimbu-error';
-
-export { Arr, Entry, RimbuError };
+export * as Arr from './arr';
+export * as Entry from './entry';
+export * as RimbuError from './rimbu-error';
+export * from './plain-object';
 
 export * from './internal';

package/src/plain-object.ts

@@ -0,0 +1,72 @@
+/**
+ * Matches any type of function
+ */
+export type AnyFunc = (...args: any[]) => any;
+
+/**
+ * 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.
+ */
+export type IsObjWithoutFunctions<T extends Record<any, any>> =
+  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)
+ * - it is not a function
+ * - it is not iterable
+ * - it does not have any properties that are functions
+ * Otherwise, it resolves to false
+ */
+export type IsPlainObj<T> = T extends
+  | null
+  | undefined
+  | number
+  | string
+  | boolean
+  | bigint
+  | symbol
+  | AnyFunc
+  | Iterable<unknown>
+  | AsyncIterable<unknown>
+  ? false
+  : IsObjWithoutFunctions<T>;
+
+/**
+ * Utility type that will only accept objects that are considered 'plain objects' according
+ * to the `IsPlainObj` predicate type.
+ * @typeparam T - the value type to test
+ */
+export type PlainObj<T> = IsPlainObj<T> extends true ? T : never;
+
+/**
+ * Utility type that will only return true if the input type T is equal to `any`.
+ * @typeparam T - the value type to test
+ */
+export type IsAny<T> = 0 extends 1 & T ? true : false;
+
+/**
+ * Companion function to the `IsRecord<T>` type that checks whether the given object is a pure
+ * data object.
+ * @param obj - the object to check
+ * @returns true if the given object is a pure data object
+ * @note does not check whether a record's properties are not functions
+ */
+export function isPlainObj(obj: any): boolean {
+  return (
+    typeof obj === 'object' &&
+    null !== obj &&
+    (obj.constructor === Object || !(obj.constructor instanceof Function)) &&
+    !(Symbol.iterator in obj) &&
+    !(Symbol.asyncIterator in obj)
+  );
+}
+
+/**
+ * Returns true if the given object is Iterable
+ * @param obj - the object to check
+ */
+export function isIterable(obj: any): obj is Iterable<unknown> {
+  return obj !== null && typeof obj === 'object' && Symbol.iterator in obj;
+}