@common.js/filter-obj 5.1.0

package/README.md

@@ -0,0 +1,5 @@
+# @common.js/filter-obj
+
+The [filter-obj](https://www.npmjs.com/package/filter-obj) package exported as CommonJS modules.
+
+Exported from [filter-obj@5.1.0](https://www.npmjs.com/package/filter-obj/v/5.1.0) using https://github.com/etienne-martin/common.js.

package/index.d.ts

@@ -0,0 +1,75 @@
+/**
+Filter object keys and values into a new object.
+
+@param object - The source object to filter properties from.
+@param predicate - Predicate function that determines whether a property should be assigned to the new object.
+@param keys - Property keys that should be assigned to the new object.
+
+@example
+```
+import {includeKeys} from 'filter-obj';
+
+const object = {
+	foo: true,
+	bar: false
+};
+
+const newObject = includeKeys(object, (key, value) => value === true);
+//=> {foo: true}
+
+const newObject2 = includeKeys(object, ['bar']);
+//=> {bar: false}
+```
+*/
+export function includeKeys<ObjectType extends Record<PropertyKey, any>>(
+	object: ObjectType,
+	predicate: (
+		key: keyof ObjectType,
+		value: ObjectType[keyof ObjectType]
+	) => boolean
+): Partial<ObjectType>;
+export function includeKeys<
+	ObjectType extends Record<PropertyKey, any>,
+	IncludedKeys extends keyof ObjectType,
+>(
+	object: ObjectType,
+	keys: readonly IncludedKeys[]
+): Pick<ObjectType, IncludedKeys>;
+
+/**
+Filter object keys and values into a new object.
+
+@param object - The source object to filter properties from.
+@param predicate - Predicate function that determines whether a property should not be assigned to the new object.
+@param keys - Property keys that should not be assigned to the new object.
+
+@example
+```
+import {excludeKeys} from 'filter-obj';
+
+const object = {
+	foo: true,
+	bar: false
+};
+
+const newObject = excludeKeys(object, (key, value) => value === true);
+//=> {bar: false}
+
+const newObject3 = excludeKeys(object, ['bar']);
+//=> {foo: true}
+```
+*/
+export function excludeKeys<ObjectType extends Record<PropertyKey, any>>(
+	object: ObjectType,
+	predicate: (
+		key: keyof ObjectType,
+		value: ObjectType[keyof ObjectType]
+	) => boolean
+): Partial<ObjectType>;
+export function excludeKeys<
+	ObjectType extends Record<PropertyKey, any>,
+	ExcludedKeys extends keyof ObjectType,
+>(
+	object: ObjectType,
+	keys: readonly ExcludedKeys[]
+): Omit<ObjectType, ExcludedKeys>;

package/index.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+function _export(target, all) {
+    for(var name in all)Object.defineProperty(target, name, {
+        enumerable: true,
+        get: all[name]
+    });
+}
+_export(exports, {
+    includeKeys: function() {
+        return includeKeys;
+    },
+    excludeKeys: function() {
+        return excludeKeys;
+    }
+});
+function includeKeys(object, predicate) {
+    var result = {};
+    if (Array.isArray(predicate)) {
+        var _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+        try {
+            for(var _iterator = predicate[Symbol.iterator](), _step; !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+                var key = _step.value;
+                var descriptor = Object.getOwnPropertyDescriptor(object, key);
+                if (descriptor === null || descriptor === void 0 ? void 0 : descriptor.enumerable) {
+                    Object.defineProperty(result, key, descriptor);
+                }
+            }
+        } catch (err) {
+            _didIteratorError = true;
+            _iteratorError = err;
+        } finally{
+            try {
+                if (!_iteratorNormalCompletion && _iterator.return != null) {
+                    _iterator.return();
+                }
+            } finally{
+                if (_didIteratorError) {
+                    throw _iteratorError;
+                }
+            }
+        }
+    } else {
+        var _iteratorNormalCompletion1 = true, _didIteratorError1 = false, _iteratorError1 = undefined;
+        try {
+            // `Reflect.ownKeys()` is required to retrieve symbol properties
+            for(var _iterator1 = Reflect.ownKeys(object)[Symbol.iterator](), _step1; !(_iteratorNormalCompletion1 = (_step1 = _iterator1.next()).done); _iteratorNormalCompletion1 = true){
+                var key1 = _step1.value;
+                var descriptor1 = Object.getOwnPropertyDescriptor(object, key1);
+                if (descriptor1.enumerable) {
+                    var value = object[key1];
+                    if (predicate(key1, value, object)) {
+                        Object.defineProperty(result, key1, descriptor1);
+                    }
+                }
+            }
+        } catch (err) {
+            _didIteratorError1 = true;
+            _iteratorError1 = err;
+        } finally{
+            try {
+                if (!_iteratorNormalCompletion1 && _iterator1.return != null) {
+                    _iterator1.return();
+                }
+            } finally{
+                if (_didIteratorError1) {
+                    throw _iteratorError1;
+                }
+            }
+        }
+    }
+    return result;
+}
+function excludeKeys(object, predicate) {
+    if (Array.isArray(predicate)) {
+        var set = new Set(predicate);
+        return includeKeys(object, function(key) {
+            return !set.has(key);
+        });
+    }
+    return includeKeys(object, function(key, value, object) {
+        return !predicate(key, value, object);
+    });
+}

package/license

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@common.js/filter-obj",
+  "version": "5.1.0",
+  "description": "filter-obj package exported as CommonJS modules",
+  "license": "MIT",
+  "repository": "etienne-martin/common.js",
+  "funding": "https://github.com/sponsors/sindresorhus",
+  "type": "commonjs",
+  "types": "./index.d.ts",
+  "engines": {
+    "node": ">=14.16"
+  },
+  "scripts": {
+    "test": "xo && ava && tsd"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts"
+  ],
+  "devDependencies": {
+    "ava": "^4.3.1",
+    "tsd": "^0.22.0",
+    "xo": "^0.51.0"
+  },
+  "homepage": "https://github.com/etienne-martin/common.js#readme",
+  "dependencies": {},
+  "main": "./index.js"
+}