@bbn/bbn 1.0.224 → 1.0.226

package/dist/fn/object/isWritable.d.ts

@@ -0,0 +1,38 @@
+/**
+  * Returns the value of the given field (property) from the first object matching the given filter in an array of objects.
+  *
+  * The filtering arguments follow the same scheme as bbn.fn.search.
+  *
+  * @method   isWritable
+  * @global
+  * @example
+  * ```javascript
+  * class Foo {
+  *   readonly a = 1
+  *   b = 2
+  * }
+  * const foo = new Foo();
+  * bbn.fn.isWritable(foo, 'a');
+  * // false
+  * bbn.fn.isWritable(foo, 'b');
+  * // true
+  * ```
+  *
+  * @example
+  * ```javascript
+  * class Zoo {
+  *   get a () { return 1; }
+  *   b = 2
+  * }
+  * const zoo = new Zoo();
+  * bbn.fn.isWritable(zoo, 'a');
+  * // false
+  * bbn.fn.isWritable(zoo, 'b');
+  * // true
+  * ```
+  * @memberof bbn.fn
+  * @param    {Object}       obj   The subject object
+  * @param    {keyof Object} key The property from which the value is returned
+  * @returns  {Boolean}
+  */
+export default function isWritable(obj: Object, key: keyof Object): boolean;

package/dist/fn/object/isWritable.js

@@ -0,0 +1,44 @@
+/**
+  * Returns the value of the given field (property) from the first object matching the given filter in an array of objects.
+  *
+  * The filtering arguments follow the same scheme as bbn.fn.search.
+  *
+  * @method   isWritable
+  * @global
+  * @example
+  * ```javascript
+  * class Foo {
+  *   readonly a = 1
+  *   b = 2
+  * }
+  * const foo = new Foo();
+  * bbn.fn.isWritable(foo, 'a');
+  * // false
+  * bbn.fn.isWritable(foo, 'b');
+  * // true
+  * ```
+  *
+  * @example
+  * ```javascript
+  * class Zoo {
+  *   get a () { return 1; }
+  *   b = 2
+  * }
+  * const zoo = new Zoo();
+  * bbn.fn.isWritable(zoo, 'a');
+  * // false
+  * bbn.fn.isWritable(zoo, 'b');
+  * // true
+  * ```
+  * @memberof bbn.fn
+  * @param    {Object}       obj   The subject object
+  * @param    {keyof Object} key The property from which the value is returned
+  * @returns  {Boolean}
+  */
+export default function isWritable(obj, key) {
+    var desc = Object.getOwnPropertyDescriptor(obj, key)
+        || Object.getOwnPropertyDescriptor(Object.getPrototypeOf(obj), key)
+        || {};
+    return Boolean(desc.writable);
+}
+;

package/dist/fn/object/mutateObject.d.ts

@@ -0,0 +1 @@
+export default function mutateObject(a1: any, a2: any, hashFn: any): any;

package/dist/fn/object/mutateObject.js

@@ -0,0 +1,28 @@
+import isObject from '../type/isObject.js';
+import hash from '../string/hash.js';
+import isSame from '../type/isSame.js';
+import checkType from '../type/checkType.js';
+export default function mutateObject(a1, a2, hashFn) {
+    if (!isObject(a1, a2)) {
+        throw new TypeError('mutateObject can only be called with arrays');
+    }
+    if (hashFn) {
+        checkType(hashFn, 'function', 'The hash function must be a function');
+    }
+    else {
+        hashFn = hash;
+    }
+    var mapA2 = Object.keys(a2);
+    // Remove items from a1 that are not in a2
+    for (var n in a1) {
+        if (!mapA2.includes(n)) {
+            delete a1[n];
+        }
+    }
+    mapA2.forEach(function (n) {
+        if (!isSame(a1[n], a2[n])) {
+            a1[n] = a2[n];
+        }
+    });
+    return a1;
+}

package/dist/fn.d.ts

@@ -159,6 +159,7 @@ import isValidDimension from './fn/type/isValidDimension.js';
 import isValidName from './fn/type/isValidName.js';
 import isValue from './fn/type/isValue.js';
 import isVue from './fn/type/isVue.js';
+import isWritable from './fn/object/isWritable.js';
 import iterate from './fn/loop/iterate.js';
 import lightenDarkenHex from './fn/style/lightenDarkenHex.js';
 import link from './fn/ajax/link.js';
@@ -170,6 +171,7 @@ import money from './fn/misc/money.js';
 import move from './fn/object/move.js';
 import multiorder from './fn/object/multiorder.js';
 import mutateArray from './fn/object/mutateArray.js';
+import mutateObject from './fn/object/mutateObject.js';
 import nl2br from './fn/string/nl2br.js';
 import numProperties from './fn/object/numProperties.js';
 import objectToFormData from './fn/form/objectToFormData.js';
@@ -390,6 +392,7 @@ declare const _default: {
     isValidName: typeof isValidName;
     isValue: typeof isValue;
     isVue: typeof isVue;
+    isWritable: typeof isWritable;
     iterate: typeof iterate;
     lightenDarkenHex: typeof lightenDarkenHex;
     link: typeof link;
@@ -401,6 +404,7 @@ declare const _default: {
     move: typeof move;
     multiorder: typeof multiorder;
     mutateArray: typeof mutateArray;
+    mutateObject: typeof mutateObject;
     nl2br: typeof nl2br;
     numProperties: typeof numProperties;
     objectToFormData: typeof objectToFormData;

package/dist/fn.js

@@ -159,6 +159,7 @@ import isValidDimension from './fn/type/isValidDimension.js';
 import isValidName from './fn/type/isValidName.js';
 import isValue from './fn/type/isValue.js';
 import isVue from './fn/type/isVue.js';
+import isWritable from './fn/object/isWritable.js';
 import iterate from './fn/loop/iterate.js';
 import lightenDarkenHex from './fn/style/lightenDarkenHex.js';
 import link from './fn/ajax/link.js';
@@ -170,6 +171,7 @@ import money from './fn/misc/money.js';
 import move from './fn/object/move.js';
 import multiorder from './fn/object/multiorder.js';
 import mutateArray from './fn/object/mutateArray.js';
+import mutateObject from './fn/object/mutateObject.js';
 import nl2br from './fn/string/nl2br.js';
 import numProperties from './fn/object/numProperties.js';
 import objectToFormData from './fn/form/objectToFormData.js';
@@ -390,6 +392,7 @@ export default {
     isValidName: isValidName,
     isValue: isValue,
     isVue: isVue,
+    isWritable: isWritable,
     iterate: iterate,
     lightenDarkenHex: lightenDarkenHex,
     link: link,
@@ -401,6 +404,7 @@ export default {
     move: move,
     multiorder: multiorder,
     mutateArray: mutateArray,
+    mutateObject: mutateObject,
     nl2br: nl2br,
     numProperties: numProperties,
     objectToFormData: objectToFormData,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bbn/bbn",
-  "version": "1.0.224",
+  "version": "1.0.226",
   "description": "Javascript toolkit",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",