diff --git a/README.md b/README.md index be0610bc8..345005740 100644 --- a/README.md +++ b/README.md @@ -168,6 +168,7 @@ average(1, 2, 3); * [`remove`](#remove) * [`sample`](#sample) * [`sampleSize`](#samplesize) +* [`shank`](#shank) * [`shuffle`](#shuffle) * [`similarity`](#similarity) * [`sortedIndex`](#sortedindex) @@ -2353,6 +2354,38 @@ sampleSize([1, 2, 3], 2); // [3,1] sampleSize([1, 2, 3], 4); // [2,3,1] ``` + + +
[⬆ Back to top](#table-of-contents) + +### shank + +Has the same functionality as [`Array.prototype.splice()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/splice), but returning a new array instead of mutating the original array. + +Use `Array.slice()` and `Array.concat()` to get a new array with the new contents after removing existing elements and/or adding new elements. +Omit the second argument, `index`, to start at `0`. +Omit the third argument, `delCount`, to remove `0` elements. +Omit the fourth argument, `elements`, in order to not add any new elements. + +```js +const shank = (arr, index = 0, delCount = 0, ...elements) => + arr + .slice(0, index) + .concat(elements) + .concat(arr.slice(index + delCount)); +``` + +
+Examples + +```js +const names = ['alpha', 'bravo', 'charlie']; +const namesAndDelta = shank(names, 1, 0, 'delta'); // [ 'alpha', 'delta', 'bravo', 'charlie' ] +const namesNoBravo = shank(names, 1, 1); // [ 'alpha', 'charlie' ] +console.log(names); // ['alpha', 'bravo', 'charlie'] +``` + +

[⬆ Back to top](#table-of-contents) diff --git a/docs/adapter.html b/docs/adapter.html index 9f9364f84..f67a00343 100644 --- a/docs/adapter.html +++ b/docs/adapter.html @@ -73,7 +73,7 @@ },1700); } }, 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/browser.html b/docs/browser.html
index f8f06c73d..d639b231b 100644
--- a/docs/browser.html
+++ b/docs/browser.html
@@ -73,7 +73,7 @@
             },1700);
           }
         }, 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 9e0995222..6e3ce15d0 100644
--- a/docs/date.html
+++ b/docs/date.html
@@ -73,7 +73,7 @@
             },1700);
           }
         }, 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 dbd6d6c4b..bf127f20a 100644
--- a/docs/function.html
+++ b/docs/function.html
@@ -73,7 +73,7 @@
             },1700);
           }
         }, 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/index.html b/docs/index.html
index 66cd5ed5e..0caf14770 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -73,7 +73,7 @@
             },1700);
           }
         }, 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 in an array 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]);
@@ -406,6 +406,15 @@
 };
 
sampleSize([1, 2, 3], 2); // [3,1]
 sampleSize([1, 2, 3], 4); // [2,3,1]
+
shank
Has the same functionality as Array.prototype.splice(), but returning a new array instead of mutating the original array.
Use Array.slice() and Array.concat() to get a new array with the new contents after removing existing elements and/or adding new elements. Omit the second argument, index, to start at 0. Omit the third argument, delCount, to remove 0 elements. Omit the fourth argument, elements, in order to not add any new elements.
const shank = (arr, index = 0, delCount = 0, ...elements) =>
+  arr
+    .slice(0, index)
+    .concat(elements)
+    .concat(arr.slice(index + delCount));
+
const names = ['alpha', 'bravo', 'charlie'];
+const namesAndDelta = shank(names, 1, 0, 'delta'); // [ 'alpha', 'delta', 'bravo', 'charlie' ]
+const namesNoBravo = shank(names, 1, 1); // [ 'alpha', 'charlie' ]
+console.log(names); // ['alpha', 'bravo', 'charlie']
 
shuffle
Randomizes the order of the values of an array, returning a new array.
Uses the Fisher-Yates algorithm to reorder the elements of the array.
const shuffle = ([...arr]) => {
   let m = arr.length;
   while (m) {
diff --git a/docs/math.html b/docs/math.html
index 7531fb8ad..057c243ec 100644
--- a/docs/math.html
+++ b/docs/math.html
@@ -73,7 +73,7 @@
             },1700);
           }
         }, 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 77b1453e6..f25f7df2f 100644
--- a/docs/node.html
+++ b/docs/node.html
@@ -73,7 +73,7 @@
             },1700);
           }
         }, 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 e2d946278..1cc493078 100644
--- a/docs/object.html
+++ b/docs/object.html
@@ -73,7 +73,7 @@
             },1700);
           }
         }, 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]),
diff --git a/docs/string.html b/docs/string.html
index 65d5625e8..c319775dc 100644
--- a/docs/string.html
+++ b/docs/string.html
@@ -73,7 +73,7 @@
             },1700);
           }
         }, 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 b6e7cdb29..24ea5a3cf 100644
--- a/docs/type.html
+++ b/docs/type.html
@@ -73,7 +73,7 @@
             },1700);
           }
         }, 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 fdf5d16fb..29cbc1f27 100644
--- a/docs/utility.html
+++ b/docs/utility.html
@@ -73,7 +73,7 @@
             },1700);
           }
         }, 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/shank.md b/snippets/shank.md
index daa944d19..e6b96d8d3 100644
--- a/snippets/shank.md
+++ b/snippets/shank.md
@@ -8,10 +8,11 @@ Omit the third argument, `delCount`, to remove `0` elements.
 Omit the fourth argument, `elements`, in order to not add any new elements.
 
 ```js
-const shank = (arr, index = 0, delCount = 0, ...elements) => 
-  arr.slice(0, index)
-     .concat(elements)
-     .concat(arr.slice(index + delCount));
+const shank = (arr, index = 0, delCount = 0, ...elements) =>
+  arr
+    .slice(0, index)
+    .concat(elements)
+    .concat(arr.slice(index + delCount));
 ```
 
 ```js