From cb98d837b29cdfd09d508c1fa88b4911b6fef37b Mon Sep 17 00:00:00 2001 From: 30secondsofcode <30secondsofcode@gmail.com> Date: Sat, 1 Sep 2018 10:09:50 +0000 Subject: [PATCH] Travis build: 313 --- README.md | 32 ++++++++++++++++++++++++++++++++ docs/adapter.html | 2 +- docs/array.html | 2 +- docs/browser.html | 2 +- docs/date.html | 2 +- docs/function.html | 2 +- docs/math.html | 2 +- docs/node.html | 2 +- docs/object.html | 13 ++++++++++++- docs/string.html | 2 +- docs/type.html | 2 +- docs/utility.html | 2 +- snippets/deepFreeze.md | 4 +--- 13 files changed, 55 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 44f3bf9b4..202571fa0 100644 --- a/README.md +++ b/README.md @@ -359,6 +359,7 @@ average(1, 2, 3); * [`bindAll`](#bindall) * [`deepClone`](#deepclone) +* [`deepFreeze`](#deepfreeze) * [`defaults`](#defaults) * [`dig`](#dig) * [`equals`](#equals-) @@ -6496,6 +6497,37 @@ const b = deepClone(a); // a !== b, a.obj !== b.obj
[⬆ Back to top](#table-of-contents) +### deepFreeze + +Deep freezes an object. + +Calls `Object.freeze(obj)` recursively on all unfrozen properties of passed object that are `instanceof` object. + +```js +const deepFreeze = obj => + Object.keys(obj).forEach( + prop => + !obj[prop] instanceof Object || Object.isFrozen(obj[prop]) ? null : deepFreeze(obj[prop]) + ) || Object.freeze(obj); +``` + +
+Examples + +```js +'use strict'; + +const o = deepFreeze([1, [2, 3]]); + +o[0] = 3; // not allowed +o[1][0] = 4; // not allowed as well +``` + +
+ +
[⬆ Back to top](#table-of-contents) + + ### defaults Assigns default values for all properties in an object that are `undefined`. diff --git a/docs/adapter.html b/docs/adapter.html index e0f7d1c64..14a90f377 100644 --- a/docs/adapter.html +++ b/docs/adapter.html @@ -79,7 +79,7 @@ document.getElementById('doc-drawer-checkbox').checked = false; } }, false); - }

logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.

 

Adapter

ary

Creates a function that accepts up to n arguments, ignoring any additional arguments.

Call the provided function, fn, with up to n arguments, using Array.slice(0,n) and the spread operator (...).

const ary = (fn, n) => (...args) => fn(...args.slice(0, n));
+      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Adapter
ary
Creates a function that accepts up to n arguments, ignoring any additional arguments.
Call the provided function, fn, with up to n arguments, using Array.slice(0,n) and the spread operator (...).
const ary = (fn, n) => (...args) => fn(...args.slice(0, n));
 
const firstTwoMax = ary(Math.max, 2);
 [[2, 6, 'a'], [8, 4, 6], [10]].map(x => firstTwoMax(...x)); // [6, 8, 10]
 
call
Given a key and a set of arguments, call them when given a context. Primarily useful in composition.
Use a closure to call a stored key with stored arguments.
const call = (key, ...args) => context => context[key](...args);
diff --git a/docs/array.html b/docs/array.html
index bf6da70d6..59167a256 100644
--- a/docs/array.html
+++ b/docs/array.html
@@ -79,7 +79,7 @@
             document.getElementById('doc-drawer-checkbox').checked = false;
           }
         }, false);
-      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Array
all
Returns true if the provided predicate function returns true for all elements in a collection, false otherwise.
Use Array.every() to test if all elements in the collection return true based on fn. Omit the second argument, fn, to use Boolean as a default.
const all = (arr, fn = Boolean) => arr.every(fn);
+      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Array
all
Returns true if the provided predicate function returns true for all elements in a collection, false otherwise.
Use Array.every() to test if all elements in the collection return true based on fn. Omit the second argument, fn, to use Boolean as a default.
const all = (arr, fn = Boolean) => arr.every(fn);
 
all([4, 2, 3], x => x > 1); // true
 all([1, 2, 3]); // true
 
allEqual
Check if all elements are equal
Use Array.every() to check if all the elements of the array are the same as the first one.
const allEqual = arr => arr.every(val => val === arr[0]);
diff --git a/docs/browser.html b/docs/browser.html
index 465f9e9a8..55f2fc98a 100644
--- a/docs/browser.html
+++ b/docs/browser.html
@@ -79,7 +79,7 @@
             document.getElementById('doc-drawer-checkbox').checked = false;
           }
         }, false);
-      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Browser
arrayToHtmlList
Converts the given array elements into <li> tags and appends them to the list of the given id.
Use Array.map(), document.querySelector(), and an anonymous inner closure to create a list of html tags.
const arrayToHtmlList = (arr, listID) =>
+      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Browser
arrayToHtmlList
Converts the given array elements into <li> tags and appends them to the list of the given id.
Use Array.map(), document.querySelector(), and an anonymous inner closure to create a list of html tags.
const arrayToHtmlList = (arr, listID) =>
   (el => (
     (el = document.querySelector('#' + listID)),
     (el.innerHTML += arr.map(item => `<li>${item}</li>`).join(''))
diff --git a/docs/date.html b/docs/date.html
index 8f3116190..62132e292 100644
--- a/docs/date.html
+++ b/docs/date.html
@@ -79,7 +79,7 @@
             document.getElementById('doc-drawer-checkbox').checked = false;
           }
         }, false);
-      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Date
formatDuration
Returns the human readable format of the given number of milliseconds.
Divide ms with the appropriate values to obtain the appropriate values for day, hour, minute, second and millisecond. Use Object.entries() with Array.filter() to keep only non-zero values. Use Array.map() to create the string for each value, pluralizing appropriately. Use String.join(', ') to combine the values into a string.
const formatDuration = ms => {
+      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Date
formatDuration
Returns the human readable format of the given number of milliseconds.
Divide ms with the appropriate values to obtain the appropriate values for day, hour, minute, second and millisecond. Use Object.entries() with Array.filter() to keep only non-zero values. Use Array.map() to create the string for each value, pluralizing appropriately. Use String.join(', ') to combine the values into a string.
const formatDuration = ms => {
   if (ms < 0) ms = -ms;
   const time = {
     day: Math.floor(ms / 86400000),
diff --git a/docs/function.html b/docs/function.html
index 8a7eb96d6..8ed5254cf 100644
--- a/docs/function.html
+++ b/docs/function.html
@@ -79,7 +79,7 @@
             document.getElementById('doc-drawer-checkbox').checked = false;
           }
         }, false);
-      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Function
attempt
Attempts to invoke a function with the provided arguments, returning either the result or the caught error object.
Use a try... catch block to return either the result of the function or an appropriate error.
const attempt = (fn, ...args) => {
+      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Function
attempt
Attempts to invoke a function with the provided arguments, returning either the result or the caught error object.
Use a try... catch block to return either the result of the function or an appropriate error.
const attempt = (fn, ...args) => {
   try {
     return fn(...args);
   } catch (e) {
diff --git a/docs/math.html b/docs/math.html
index 1ae74e222..014512c33 100644
--- a/docs/math.html
+++ b/docs/math.html
@@ -79,7 +79,7 @@
             document.getElementById('doc-drawer-checkbox').checked = false;
           }
         }, false);
-      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Math
approximatelyEqual
Checks if two numbers are approximately equal to each other.
Use Math.abs() to compare the absolute difference of the two values to epsilon. Omit the third parameter, epsilon, to use a default value of 0.001.
const approximatelyEqual = (v1, v2, epsilon = 0.001) => Math.abs(v1 - v2) < epsilon;
+      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Math
approximatelyEqual
Checks if two numbers are approximately equal to each other.
Use Math.abs() to compare the absolute difference of the two values to epsilon. Omit the third parameter, epsilon, to use a default value of 0.001.
const approximatelyEqual = (v1, v2, epsilon = 0.001) => Math.abs(v1 - v2) < epsilon;
 
approximatelyEqual(Math.PI / 2.0, 1.5708); // true
 
average
Returns the average of two or more numbers.
Use Array.reduce() to add each value to an accumulator, initialized with a value of 0, divide by the length of the array.
const average = (...nums) => nums.reduce((acc, val) => acc + val, 0) / nums.length;
 
average(...[1, 2, 3]); // 2
diff --git a/docs/node.html b/docs/node.html
index 8de9947c3..d17685100 100644
--- a/docs/node.html
+++ b/docs/node.html
@@ -79,7 +79,7 @@
             document.getElementById('doc-drawer-checkbox').checked = false;
           }
         }, false);
-      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Node
atob
Decodes a string of data which has been encoded using base-64 encoding.
Create a Buffer for the given string with base-64 encoding and use Buffer.toString('binary') to return the decoded string.
const atob = str => new Buffer(str, 'base64').toString('binary');
+      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Node
atob
Decodes a string of data which has been encoded using base-64 encoding.
Create a Buffer for the given string with base-64 encoding and use Buffer.toString('binary') to return the decoded string.
const atob = str => new Buffer(str, 'base64').toString('binary');
 
atob('Zm9vYmFy'); // 'foobar'
 
btoa
Creates a base-64 encoded ASCII string from a String object in which each character in the string is treated as a byte of binary data.
Create a Buffer for the given string with binary encoding and use Buffer.toString('base64') to return the encoded string.
const btoa = str => new Buffer(str, 'binary').toString('base64');
 
btoa('foobar'); // 'Zm9vYmFy'
diff --git a/docs/object.html b/docs/object.html
index 7c8cc0752..3616d2754 100644
--- a/docs/object.html
+++ b/docs/object.html
@@ -79,7 +79,7 @@
             document.getElementById('doc-drawer-checkbox').checked = false;
           }
         }, false);
-      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Object
bindAll
Binds methods of an object to the object itself, overwriting the existing method.
Use Array.forEach() to return a function that uses Function.apply() to apply the given context (obj) to fn for each function specified.
const bindAll = (obj, ...fns) =>
+      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Object
bindAll
Binds methods of an object to the object itself, overwriting the existing method.
Use Array.forEach() to return a function that uses Function.apply() to apply the given context (obj) to fn for each function specified.
const bindAll = (obj, ...fns) =>
   fns.forEach(
     fn => (
       (f = obj[fn]),
@@ -105,6 +105,17 @@
 };
 
const a = { foo: 'bar', obj: { a: 1, b: 2 } };
 const b = deepClone(a); // a !== b, a.obj !== b.obj
+
deepFreeze
Deep freezes an object.
Calls Object.freeze(obj) recursively on all unfrozen properties of passed object that are instanceof object.
const deepFreeze = obj =>
+  Object.keys(obj).forEach(
+    prop =>
+      !obj[prop] instanceof Object || Object.isFrozen(obj[prop]) ? null : deepFreeze(obj[prop])
+  ) || Object.freeze(obj);
+
'use strict';
+
+const o = deepFreeze([1, [2, 3]]);
+
+o[0] = 3; // not allowed
+o[1][0] = 4; // not allowed as well
 
defaults
Assigns default values for all properties in an object that are undefined.
Use Object.assign() to create a new empty object and copy the original one to maintain key order, use Array.reverse() and the spread operator ... to combine the default values from left to right, finally use obj again to overwrite properties that originally had a value.
const defaults = (obj, ...defs) => Object.assign({}, obj, ...defs.reverse(), obj);
 
defaults({ a: 1 }, { b: 2 }, { b: 6 }, { a: 3 }); // { a: 1, b: 2 }
 
dig
Returns the target value in a nested JSON object, based on the given key.
Use the in operator to check if target exists in obj. If found, return the value of obj[target], otherwise use Object.values(obj) and Array.reduce() to recursively call dig on each nested object until the first matching key/value pair is found.
const dig = (obj, target) =>
diff --git a/docs/string.html b/docs/string.html
index dce1a4a05..778d8d658 100644
--- a/docs/string.html
+++ b/docs/string.html
@@ -79,7 +79,7 @@
             document.getElementById('doc-drawer-checkbox').checked = false;
           }
         }, false);
-      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
String
byteSize
Returns the length of a string in bytes.
Convert a given string to a Blob Object and find its size.
const byteSize = str => new Blob([str]).size;
+      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
String
byteSize
Returns the length of a string in bytes.
Convert a given string to a Blob Object and find its size.
const byteSize = str => new Blob([str]).size;
 
byteSize('😀'); // 4
 byteSize('Hello World'); // 11
 
capitalize
Capitalizes the first letter of a string.
Use array destructuring and String.toUpperCase() to capitalize first letter, ...rest to get array of characters after first letter and then Array.join('') to make it a string again. Omit the lowerRest parameter to keep the rest of the string intact, or set it to true to convert to lowercase.
const capitalize = ([first, ...rest], lowerRest = false) =>
diff --git a/docs/type.html b/docs/type.html
index b1d1377cd..5bb220519 100644
--- a/docs/type.html
+++ b/docs/type.html
@@ -79,7 +79,7 @@
             document.getElementById('doc-drawer-checkbox').checked = false;
           }
         }, false);
-      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Type
getType
Returns the native type of a value.
Returns lowercased constructor name of value, "undefined" or "null" if value is undefined or null.
const getType = v =>
+      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Type
getType
Returns the native type of a value.
Returns lowercased constructor name of value, "undefined" or "null" if value is undefined or null.
const getType = v =>
   v === undefined ? 'undefined' : v === null ? 'null' : v.constructor.name.toLowerCase();
 
getType(new Set([1, 2, 3])); // 'set'
 
is
Checks if the provided value is of the specified type.
Ensure the value is not undefined or null using Array.includes(), and compare the constructor property on the value with type to check if the provided value is of the specified type.
const is = (type, val) => ![, null].includes(val) && val.constructor === type;
diff --git a/docs/utility.html b/docs/utility.html
index 764bc43ea..a01bd86ce 100644
--- a/docs/utility.html
+++ b/docs/utility.html
@@ -79,7 +79,7 @@
             document.getElementById('doc-drawer-checkbox').checked = false;
           }
         }, false);
-      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Utility
castArray
Casts the provided value as an array if it's not one.
Use Array.isArray() to determine if val is an array and return it as-is or encapsulated in an array accordingly.
const castArray = val => (Array.isArray(val) ? val : [val]);
+      }
logo 30 seconds of code Curated collection of useful JavaScript snippets that you can understand in 30 seconds or less.
 
Utility
castArray
Casts the provided value as an array if it's not one.
Use Array.isArray() to determine if val is an array and return it as-is or encapsulated in an array accordingly.
const castArray = val => (Array.isArray(val) ? val : [val]);
 
castArray('foo'); // ['foo']
 castArray([1]); // [1]
 
cloneRegExp
Clones a regular expression.
Use new RegExp(), RegExp.source and RegExp.flags to clone the given regular expression.
const cloneRegExp = regExp => new RegExp(regExp.source, regExp.flags);
diff --git a/snippets/deepFreeze.md b/snippets/deepFreeze.md
index 4d6e40728..f358278c1 100644
--- a/snippets/deepFreeze.md
+++ b/snippets/deepFreeze.md
@@ -8,9 +8,7 @@ Calls `Object.freeze(obj)` recursively on all unfrozen properties of passed obje
 const deepFreeze = obj =>
   Object.keys(obj).forEach(
     prop =>
-      !obj[prop] instanceof Object || Object.isFrozen(obj[prop])
-        ? null
-        : deepFreeze(obj[prop])
+      !obj[prop] instanceof Object || Object.isFrozen(obj[prop]) ? null : deepFreeze(obj[prop])
   ) || Object.freeze(obj);
 ```