@blakek/deep - npm Package Compare versions

Comparing version 2.0.1 to 2.1.0

dist/index.cjs.js

@@ -65,2 +65,6 @@ 'use strict';
 
+function _pluck(properties, object) {
+  return properties.reduce((subset, property) => _set(_get(property, object), property, subset), {});
+}
+
 function _set(value, path, object) {
@@ -87,2 +91,3 @@ const parsedPath = pathington.parse(path);
 const has = curry.curry(_has);
+const pluck = curry.curry(_pluck);
 const remove = curry.curry(_remove);
@@ -94,4 +99,5 @@ const set = curry.curry(_set);
 exports.has = has;
+exports.pluck = pluck;
 exports.remove = remove;
 exports.set = set;
 exports.traverseObject = traverseObject;

dist/index.d.ts

@@ -0,7 +1,9 @@
+/// <reference types="pathington" />
 export declare type Path = Array<number | string> | string;
 export declare function traverseObject(object: any, path: string[]): any;
-export declare const get: import("@blakek/curry").Curry2<Path, any, any>;
-export declare const getOr: import("@blakek/curry").Curry3<any, Path, any, any>;
-export declare const has: import("@blakek/curry").Curry2<Path, any, boolean>;
-export declare const remove: import("@blakek/curry").Curry2<Path, any, any>;
-export declare const set: import("@blakek/curry").Curry3<any, Path, any, any>;
+export declare const get: import("@blakek/curry").Curry2<import("pathington").Path, any, any>;
+export declare const getOr: import("@blakek/curry").Curry3<any, import("pathington").Path, any, any>;
+export declare const has: import("@blakek/curry").Curry2<import("pathington").Path, any, boolean>;
+export declare const pluck: import("@blakek/curry").Curry2<import("pathington").Path[], any, any>;
+export declare const remove: import("@blakek/curry").Curry2<import("pathington").Path, any, any>;
+export declare const set: import("@blakek/curry").Curry3<any, import("pathington").Path, any, any>;

dist/index.esm.js

@@ -61,2 +61,6 @@ import { curry } from '@blakek/curry';
 
+function _pluck(properties, object) {
+  return properties.reduce((subset, property) => _set(_get(property, object), property, subset), {});
+}
+
 function _set(value, path, object) {
@@ -83,5 +87,6 @@ const parsedPath = parse(path);
 const has = curry(_has);
+const pluck = curry(_pluck);
 const remove = curry(_remove);
 const set = curry(_set);
 
-export { get, getOr, has, remove, set, traverseObject };
+export { get, getOr, has, pluck, remove, set, traverseObject };

dist/index.umd.js

@@ -1,2 +0,2 @@
-!function(e,r){"object"==typeof exports&&"undefined"!=typeof module?r(exports):"function"==typeof define&&define.amd?define(["exports"],r):r((e=e||self).deep={})}(this,(function(e){"use strict";function r(e,r){return void 0===r&&(r=e.length),function n(){for(var t=arguments.length,u=new Array(t),i=0;i<t;i++)u[i]=arguments[i];return u.length>=r?e.apply(void 0,u.slice(0,r)):function(){for(var e=arguments.length,r=new Array(e),t=0;t<e;t++)r[t]=arguments[t];return n.apply(void 0,u.concat(r))}}}var n={clear:function(){n.results={},n.size=0},results:{},size:0},t=/"[^"]+"|`[^`]+`|'[^']+'|[^.[\]]+/g,u=/^\d+$/i,i=/^"[^"]+"|`[^`]+`|'[^']+'$/,o=function(e,r){for(var n=e.length,t=[],u=0;u<n;u++)t[u]=r(e[u]);return t},f=function(e){var r=function(e){return i.test(e)}(e)?e.slice(1,e.length-1):e;return function(e){return!(!e||!e.length)&&u.test(e)}(r)?+r:r},c=Array.isArray,l=function(e){if("string"==typeof e)return function(e){return n.results[e]||(n.size>500&&n.clear(),n.results[e]=e?o(e.match(t),f):[e],n.size++),n.results[e]}(e);if(c(e))return o(e,f);var r=f(e);return["number"==typeof r?r:""+r]};function s(e){if(null===e)return!1;var r=typeof e;return"object"===r||"function"===r}var a=Symbol("curriable placeholder");function v(e,r){if(0===r.length)return e;if(!s(e))return a;var n=r[0],t=r.slice(1);return n in e?v(e[n],t):a}function d(e,r,n){if(void 0===r)return n;var t=v(n,l(r));return t===a||void 0===t?e:t}var p=r((function(e,r){return d(void 0,e,r)})),h=r(d),g=r((function(e,r){return v(r,l(e))!==a})),y=r((function(e,r){if(void 0===e)return r;var n=l(e),t=n.slice(0,-1),u=n[n.length-1],i=v(r,l(t));return i?(delete i[u],r):r})),b=r((function(e,r,n){var t=l(r),u=n;return t.forEach((function(r,n){n!==t.length-1?(s(u[r])||(u[r]={}),u=u[r]):u[r]=e})),n}));e.get=p,e.getOr=h,e.has=g,e.remove=y,e.set=b,e.traverseObject=v,Object.defineProperty(e,"__esModule",{value:!0})}));
+!function(e,r){"object"==typeof exports&&"undefined"!=typeof module?r(exports):"function"==typeof define&&define.amd?define(["exports"],r):r((e=e||self).deep={})}(this,(function(e){"use strict";function r(e,r){return void 0===r&&(r=e.length),function n(){for(var t=arguments.length,u=new Array(t),i=0;i<t;i++)u[i]=arguments[i];return u.length>=r?e.apply(void 0,u.slice(0,r)):function(){for(var e=arguments.length,r=new Array(e),t=0;t<e;t++)r[t]=arguments[t];return n.apply(void 0,u.concat(r))}}}var n={clear:function(){n.results={},n.size=0},results:{},size:0},t=/"[^"]+"|`[^`]+`|'[^']+'|[^.[\]]+/g,u=/^\d+$/i,i=/^"[^"]+"|`[^`]+`|'[^']+'$/,o=function(e,r){for(var n=e.length,t=[],u=0;u<n;u++)t[u]=r(e[u]);return t},f=function(e){var r=function(e){return i.test(e)}(e)?e.slice(1,e.length-1):e;return function(e){return!(!e||!e.length)&&u.test(e)}(r)?+r:r},c=Array.isArray,l=function(e){if("string"==typeof e)return function(e){return n.results[e]||(n.size>500&&n.clear(),n.results[e]=e?o(e.match(t),f):[e],n.size++),n.results[e]}(e);if(c(e))return o(e,f);var r=f(e);return["number"==typeof r?r:""+r]};function s(e){if(null===e)return!1;var r=typeof e;return"object"===r||"function"===r}var a=Symbol("curriable placeholder");function v(e,r){if(0===r.length)return e;if(!s(e))return a;var n=r[0],t=r.slice(1);return n in e?v(e[n],t):a}function d(e,r,n){if(void 0===r)return n;var t=v(n,l(r));return t===a||void 0===t?e:t}var p=function(e,r){return d(void 0,e,r)};function h(e,r,n){var t=l(r),u=n;return t.forEach((function(r,n){n!==t.length-1?(s(u[r])||(u[r]={}),u=u[r]):u[r]=e})),n}var g=r(p),y=r(d),b=r((function(e,r){return v(r,l(e))!==a})),m=r((function(e,r){return e.reduce((function(e,n){return h(p(n,r),n,e)}),{})})),j=r((function(e,r){if(void 0===e)return r;var n=l(e),t=n.slice(0,-1),u=n[n.length-1],i=v(r,l(t));return i?(delete i[u],r):r})),z=r(h);e.get=g,e.getOr=y,e.has=b,e.pluck=m,e.remove=j,e.set=z,e.traverseObject=v,Object.defineProperty(e,"__esModule",{value:!0})}));
 //# sourceMappingURL=index.umd.js.map

package.json

 {
   "name": "@blakek/deep",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "main": "dist/index.cjs.js",
@@ -5,0 +5,0 @@ "module": "dist/index.esm.js",

README.md

@@ -28,3 +28,3 @@ # deep
 ```js
-import { get, getOr, has, remove, set } from '@blakek/deep';
+import { get, getOr, has, pluck remove, set } from '@blakek/deep';
 
@@ -54,2 +54,6 @@ const user = {
 
+// Pluck a subset of properties
+pluck(['id', 'roles'], user);
+//» { id: 'abf87de', roles: [ 'alert:create', 'alert:read' ] }
+
 // Remove a property value
@@ -171,2 +175,26 @@ remove('a', { a: 42, b: 123 }); //» { b: 123 }
 
+### `pluck`
+
+```ts
+function pluck(properties: Path[], object: any): any;
+```
+
+Gets a subset of properties from an object.
+
+```js
+const user = {
+  username: 'blakek',
+  roles: ['alert:create', 'alert:read'],
+  sites: {
+    github: {
+      username: 'blakek'
+    }
+  }
+};
+
+pluck(['username'], user); //» { username: 'blakek' }
+pluck(['username', 'roles'], user);
+//» { username: 'blakek', roles: [ 'alert:create', 'alert:read' ] }
+```
+
 ### `set`
@@ -173,0 +201,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

131920

increased by1.36%

Lines of code

167

increased by7.05%

Number of lines in readme file

248

increased by12.73%

No dependency changes