@bbn/bbn 1.0.225 → 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.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';
@@ -391,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;

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';
@@ -391,6 +392,7 @@ export default {
     isValidName: isValidName,
     isValue: isValue,
     isVue: isVue,
+    isWritable: isWritable,
     iterate: iterate,
     lightenDarkenHex: lightenDarkenHex,
     link: link,

package/package.json

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