feat: Object.clear util

README.md

@@ -24,6 +24,7 @@ npm install ext
   - [`floor10`](docs/math/floor-10.md)
   - [`round10`](docs/math/round-10.md)
 - `Object`
+  - [`clear`](docs/object/clear.md)
   - [`entries`](docs/object/entries.md)
 - `Promise`
   - [`limit`](docs/promise/limit.md)

docs/object/clear.md

@@ -0,0 +1,12 @@
+# `Object.clear` _(ext/object/clear)_
+
+Deletes all own, enumerable, non-symbol properties in the object
+
+```javascript
+const clear = require("ext/object/clear");
+
+const obj = { foo: "bar" };
+
+clear(obj);
+Object.keys(obj); // []
+```

object/clear.js

@@ -0,0 +1,15 @@
+"use strict";
+
+var ensureObject = require("type/object/ensure")
+  , ensure       = require("type/ensure");
+
+var objPropertyIsEnumerable = Object.prototype.propertyIsEnumerable;
+
+module.exports = function (object) {
+	ensure(["object", object, ensureObject]);
+	for (var key in object) {
+		if (!objPropertyIsEnumerable.call(object, key)) continue;
+		delete object[key];
+	}
+	return object;
+};

test/object/clear.js

@@ -0,0 +1,26 @@
+"use strict";
+
+var assert = require("chai").assert
+  , clear  = require("../../object/clear");
+
+describe("object/clear", function () {
+	it("Should clear enumerable properties", function () {
+		var obj = { foo: "bar", elo: "sfds" };
+		clear(obj);
+		// eslint-disable-next-line no-unreachable-loop
+		for (var key in obj) throw new Error("Unexpected" + key);
+	});
+	it("Should return input object", function () {
+		var obj = {};
+		assert.equal(clear(obj), obj);
+	});
+	if (Object.defineProperty && Object.keys) {
+		it("Should keep non enumerable properties", function () {
+			var obj = { foo: "bar", elo: "sfds" };
+			Object.defineProperty(obj, "hidden", { value: "some" });
+			clear(obj);
+			assert.deepEqual(Object.keys(obj), []);
+			assert.equal(obj.hidden, "some");
+		});
+	}
+});