Updated examples

Removed duplicate and unnecessary examples.

snippets/chainAsync.md

@@ -20,10 +20,6 @@ chainAsync([
   },
   next => {
     console.log('1 second');
-    setTimeout(next, 1000);
-  },
-  next => {
-    console.log('2 seconds');
   }
 ]);
 ```

snippets/clampNumber.md

@@ -12,5 +12,4 @@ const clampNumber = (num, a, b) => Math.max(Math.min(num, Math.max(a, b)), Math.
 ```js
 clampNumber(2, 3, 5); // 3
 clampNumber(1, -1, -5); // -1
-clampNumber(3, 2, 4); // 3
 ```

snippets/collatz.md

@@ -10,5 +10,4 @@ const collatz = n => (n % 2 == 0 ? n / 2 : 3 * n + 1);
 
 ```js
 collatz(8); // 4
-collatz(5); // 16
 ```

snippets/defer.md

@@ -14,6 +14,6 @@ defer(console.log, 'a'), console.log('b'); // logs 'b' then 'a'
 
 // Example B:
 document.querySelector('#someElement').innerHTML = 'Hello';
-longRunningFunction(); // the browser will not update the HTML until this has finished
+longRunningFunction(); //Browser will not update the HTML until this has finished
-defer(longRunningFunction); // the browser will update the HTML then run the function
+defer(longRunningFunction); // Browser will update the HTML then run the function
 ```

snippets/detectDeviceType.md

@@ -12,6 +12,5 @@ const detectDeviceType = () =>
 ```
 
 ```js
-detectDeviceType(); // "Mobile"
+detectDeviceType(); // "Mobile" or "Desktop"
-detectDeviceType(); // "Desktop"
 ```

snippets/elementIsVisibleInViewport.md

@@ -20,6 +20,6 @@ const elementIsVisibleInViewport = (el, partiallyVisible = false) => {
 
 ```js
 // e.g. 100x100 viewport and a 10x10px element at position {top: -1, left: 0, bottom: 9, right: 10}
-elementIsVisibleInViewport(el); // false // (not fully visible)
+elementIsVisibleInViewport(el); // false - (not fully visible)
-elementIsVisibleInViewport(el, true); // true // (partially visible)
+elementIsVisibleInViewport(el, true); // true - (partially visible)
 ```

snippets/elo.md

@@ -18,7 +18,5 @@ const elo = ([a, b], kFactor = 32) => {
 
 ```js
 elo([1200, 1200]); // [1216, 1184]
-elo([1000, 2000]); // [1031.8991261061358, 1968.1008738938642]
-elo([1500, 1000]); // [1501.7036868864648, 998.2963131135352]
 elo([1200, 1200], 64); // [1232, 1168]
 ```

snippets/formatDuration.md

@@ -25,7 +25,6 @@ const formatDuration = ms => {
 ```
 
 ```js
-formatDuration(1001); // "1 second, 1 millisecond"
+formatDuration(1001); // '1 second, 1 millisecond'
-formatDuration(343250555); // "3 days, 23 hours, 20 minutes, 50 seconds, 555 milliseconds"
+formatDuration(34325055574); // '397 days, 6 hours, 44 minutes, 15 seconds, 574 milliseconds'
-formatDuration(34325055574); // "397 days, 6 hours, 44 minutes, 15 seconds, 574 milliseconds"
 ```

snippets/geometricProgression.md

@@ -18,5 +18,4 @@ const geometricProgression = (end, start = 1, step = 2) =>
 geometricProgression(256); // [1, 2, 4, 8, 16, 32, 64, 128, 256]
 geometricProgression(256, 3); // [3, 6, 12, 24, 48, 96, 192]
 geometricProgression(256, 1, 4); // [1, 4, 16, 64, 256]
-geometricProgression(256, 2, 1); //Gives error
 ```

snippets/getType.md

@@ -10,5 +10,5 @@ const getType = v =>
 ```
 
 ```js
-getType(new Set([1, 2, 3])); // "set"
+getType(new Set([1, 2, 3])); // 'Set'
 ```

snippets/hasFlags.md

@@ -13,7 +13,6 @@ const hasFlags = (...flags) =>
 ```js
 // node myScript.js -s --test --cool=true
 hasFlags('-s'); // true
-hasFlags('test', 'cool=true'); // true
 hasFlags('--test', 'cool=true', '-s'); // true
 hasFlags('special'); // false
 ```

snippets/howManyTimes.md

@@ -23,10 +23,7 @@ const howManyTimes = (num, divisor) => {
 
 ```js
 howManyTimes(100, 2); // 2
-howManyTimes(100, -2); //2
 howManyTimes(100, 2.5); // 2
-howManyTimes(100, 3); //0
 howManyTimes(100, 0); // 0
-howManyTimes(100, 1); //Infinity
 howManyTimes(100, -1); // Infinity
 ```

snippets/isArmstrongNumber.md

@@ -13,6 +13,5 @@ const isArmstrongNumber = digits =>
 
 ```js
 isArmstrongNumber(1634); // true
-isArmstrongNumber(371); // true
 isArmstrongNumber(56); // false
 ```

snippets/isNull.md

@@ -10,5 +10,4 @@ const isNull = val => val === null;
 
 ```js
 isNull(null); // true
-isNull('null'); // false
 ```

snippets/isPrime.md

@@ -15,5 +15,4 @@ const isPrime = num => {
 
 ```js
 isPrime(11); // true
-isPrime(12); // false
 ```

snippets/isPrimitive.md

@@ -11,12 +11,10 @@ const isPrimitive = val => !['object', 'function'].includes(typeof val) || val =
 ```
 
 ```js
-isPrimitive(window.someNonExistentProperty); // true
 isPrimitive(null); // true
 isPrimitive(50); // true
 isPrimitive('Hello!'); // true
 isPrimitive(false); // true
 isPrimitive(Symbol()); // true
 isPrimitive([]); // false
-isPrimitive(new String('Hello!')); // false
 ```

snippets/isSorted.md

@@ -16,7 +16,6 @@ const isSorted = arr => {
 ```
 
 ```js
-isSorted([0, 1, 2, 3]); // 1
 isSorted([0, 1, 2, 2]); // 1
 isSorted([4, 3, 2]); // -1
 isSorted([4, 3, 5]); // 0

snippets/isString.md

@@ -9,6 +9,5 @@ const isString = val => typeof val === 'string';
 ```
 
 ```js
-isString(10); // false
 isString('10'); // true
 ```

snippets/isSymbol.md

@@ -9,6 +9,5 @@ const isSymbol = val => typeof val === 'symbol';
 ```
 
 ```js
-isSymbol('x'); // false
 isSymbol(Symbol('x')); // true
 ```

snippets/join.md

@@ -18,7 +18,6 @@ const join = (arr, separator = ',', end = separator) =>
 ```
 
 ```js
-join(); // ''
 join(['pen', 'pineapple', 'apple', 'pen'], ',', '&'); // "pen,pineapple,apple&pen"
 join(['pen', 'pineapple', 'apple', 'pen'], ','); // "pen,pineapple,apple,pen"
 join(['pen', 'pineapple', 'apple', 'pen']); // "pen,pineapple,apple,pen"

snippets/mask.md

@@ -15,6 +15,5 @@ const mask = (cc, num = 4, mask = '*') =>
 ```js
 mask(1234567890); // '******7890'
 mask(1234567890, 3); // '*******890'
-mask(1234567890, 4, '$'); // '$$$$$$7890'
 mask(1234567890, -4, '$'); // '1234$$$$$$'
 ```

snippets/maxN.md

@@ -13,5 +13,4 @@ const maxN = (arr, n = 1) => [...arr].sort((a, b) => b - a).slice(0, n);
 ```js
 maxN([1, 2, 3]); // [3]
 maxN([1, 2, 3], 2); // [3,2]
-maxN([1, 2, 3], 4); // [3,2,1]
 ```

snippets/median.md

@@ -15,5 +15,4 @@ const median = arr => {
 
 ```js
 median([5, 6, 50, 1, -5]); // 5
-median([0, 10, -2, 7]); // 3.5
 ```

snippets/memoize.md

@@ -22,5 +22,5 @@ const memoize = fn => {
 const anagramsCached = memoize(anagrams);
 anagramsCached('javascript'); // takes a long time
 anagramsCached('javascript'); // returns virtually instantly since it's now cached
-console.log(anagramsCached.cache); // Map
+console.log(anagramsCached.cache); // The cached anagrams map
 ```

snippets/minN.md

@@ -12,5 +12,4 @@ const minN = (arr, n = 1) => [...arr].sort((a, b) => a - b).slice(0, n);
 ```js
 minN([1, 2, 3]); // [1]
 minN([1, 2, 3], 2); // [1,2]
-minN([1, 2, 3], 4); // [1,2,3]
 ```

snippets/orderBy.md

@@ -22,9 +22,8 @@ const orderBy = (arr, props, orders) =>
 const users = [
   { name: 'fred', age: 48 },
   { name: 'barney', age: 36 },
-  { name: 'fred', age: 40 },
+  { name: 'fred', age: 40 }
-  { name: 'barney', age: 34 }
 ];
-orderBy(users, ['name', 'age'], ['asc', 'desc']); // [{name: 'barney', age: 36}, {name: 'barney', age: 34}, {name: 'fred', age: 48}, {name: 'fred', age: 40}]
+orderBy(users, ['name', 'age'], ['asc', 'desc']); // [{name: 'barney', age: 36}, {name: 'fred', age: 48}, {name: 'fred', age: 40}]
-orderBy(users, ['name', 'age']); // [{name: 'barney', age: 34}, {name: 'barney', age: 36}, {name: 'fred', age: 40}, {name: 'fred', age: 48}]
+orderBy(users, ['name', 'age']); // [{name: 'barney', age: 36}, {name: 'fred', age: 40}, {name: 'fred', age: 48}]
 ```

snippets/pluralize.md

@@ -17,7 +17,6 @@ const pluralize = (val, word, plural = word + 's') => {
 pluralize(0, 'apple'); // 'apples'
 pluralize(1, 'apple'); // 'apple'
 pluralize(2, 'apple'); // 'apples'
-pluralize(1, 'person'); // 'person'
 pluralize(2, 'person', 'people'); // 'people'
 
 const PLURALS = {

snippets/prettyBytes.md

@@ -20,9 +20,6 @@ const prettyBytes = (num, precision = 3, addSpace = true) => {
 
 ```js
 prettyBytes(1000); // 1 KB
-prettyBytes(123456789); // 123 MB
+prettyBytes(-27145424323.5821, 5); // -27.145 GB
-prettyBytes(-50); // -50 B
+prettyBytes(123456789, 3, false); // 123MB
-prettyBytes(27145424323.5821); // 27.1 GB
-prettyBytes(27145424323.5821, 5); // 27.145 GB
-prettyBytes(5500, 3, false); // 5.5KB
 ```

snippets/pull.md

@@ -17,11 +17,6 @@ const pull = (arr, ...args) => {
 ```
 
 ```js
-let myArray1 = ['a', 'b', 'c', 'a', 'b', 'c'];
+let myArray = ['a', 'b', 'c', 'a', 'b', 'c'];
-pull(myArray1, 'a', 'c');
+pull(myArray, 'a', 'c'); // myArray = [ 'b', 'b' ]
-console.log(myArray1); // [ 'b', 'b' ]
-
-let myArray2 = ['a', 'b', 'c', 'a', 'b', 'c'];
-pull(myArray2, ['a', 'c']);
-console.log(myArray2); // [ 'b', 'b' ]
 ```

snippets/pullAtIndex.md

@@ -20,8 +20,5 @@ const pullAtIndex = (arr, pullArr) => {
 
 ```js
 let myArray = ['a', 'b', 'c', 'd'];
-let pulled = pullAtIndex(myArray, [1, 3]);
+let pulled = pullAtIndex(myArray, [1, 3]); // myArray = [ 'a', 'c' ] , pulled = [ 'b', 'd' ]
-
-console.log(myArray); // [ 'a', 'c' ]
-console.log(pulled); // [ 'b', 'd' ]
 ```

snippets/pullAtValue.md

@@ -19,7 +19,5 @@ const pullAtValue = (arr, pullArr) => {
 
 ```js
 let myArray = ['a', 'b', 'c', 'd'];
-let pulled = pullAtValue(myArray, ['b', 'd']);
+let pulled = pullAtValue(myArray, ['b', 'd']); // myArray = [ 'a', 'c' ] , pulled = [ 'b', 'd' ]
-console.log(myArray); // [ 'a', 'c' ]
-console.log(pulled); // [ 'b', 'd' ]
 ```

snippets/randomHexColorCode.md

@@ -13,6 +13,4 @@ const randomHexColorCode = () => {
 
 ```js
 randomHexColorCode(); // "#e34155"
-randomHexColorCode(); // "#fd73a6"
-randomHexColorCode(); // "#4144c6"
 ```

snippets/runAsync.md

@@ -37,10 +37,11 @@ const longRunningFunction = () => {
   }
   return result;
 };
-
+/*
-// NOTE: Since the function is running in a different context, closures are not supported.
+  NOTE: Since the function is running in a different context, closures are not supported.
-// The function supplied to `runAsync` gets stringified, so everything becomes literal.
+  The function supplied to `runAsync` gets stringified, so everything becomes literal.
-// All variables and functions must be defined inside.
+  All variables and functions must be defined inside.
+*/
 runAsync(longRunningFunction).then(console.log); // 209685000000
 runAsync(() => 10 ** 3).then(console.log); // 1000
 let outsideVariable = 50;

snippets/runPromisesInSeries.md

@@ -10,5 +10,5 @@ const runPromisesInSeries = ps => ps.reduce((p, next) => p.then(next), Promise.r
 
 ```js
 const delay = d => new Promise(r => setTimeout(r, d));
-runPromisesInSeries([() => delay(1000), () => delay(2000)]); // //executes each promise sequentially, taking a total of 3 seconds to complete
+runPromisesInSeries([() => delay(1000), () => delay(2000)]); // Executes each promise sequentially, taking a total of 3 seconds to complete
 ```

snippets/sdbm.md

@@ -17,5 +17,4 @@ const sdbm = str => {
 
 ```js
 console.log(sdbm('name')); // -3521204949
-console.log(sdbm('age')); // 808122783
 ```

snippets/shallowClone.md

@@ -10,6 +10,5 @@ const shallowClone = obj => Object.assign({}, obj);
 
 ```js
 const a = { x: true, y: 1 };
-const b = shallowClone(a);
+const b = shallowClone(a); // a !== b
-a === b; // false
 ```

snippets/shuffle.md

@@ -17,6 +17,5 @@ const shuffle = ([...arr]) => {
 
 ```js
 const foo = [1, 2, 3];
-shuffle(foo); // [2,3,1]
+shuffle(foo); // [2,3,1], foo = [1,2,3]
-console.log(foo); // [1,2,3]
 ```

snippets/solveRPN.md

@@ -41,8 +41,5 @@ const solveRPN = rpn => {
 
 ```js
 solveRPN('15 7 1 1 + - / 3 * 2 1 1 + + -'); // 5
-solveRPN('3 5 6 + *'); //33
-solveRPN('2 4 / 5 6 - *'); //-0.5
-solveRPN('2 3 ^'); //8
 solveRPN('2 3 ^'); // 8
 ```

snippets/spreadOver.md

@@ -11,5 +11,4 @@ const spreadOver = fn => argsArr => fn(...argsArr);
 ```js
 const arrayMax = spreadOver(Math.max);
 arrayMax([1, 2, 3]); // 3
-arrayMax([1, 2, 4]); // 4
 ```

snippets/timeTaken.md

@@ -14,6 +14,5 @@ const timeTaken = callback => {
 ```
 
 ```js
-timeTaken(() => Math.pow(2, 10)); // 1024
+timeTaken(() => Math.pow(2, 10)); // 1024, (logged): timeTaken: 0.02099609375ms
-// (logged): timeTaken: 0.02099609375ms
 ```

snippets/toSnakeCase.md

@@ -17,7 +17,6 @@ const toSnakeCase = str =>
 ```js
 toSnakeCase('camelCase'); // 'camel_case'
 toSnakeCase('some text'); // 'some_text'
-toSnakeCase('some-javascript-property'); // 'some_javascript_property'
 toSnakeCase('some-mixed_string With spaces_underscores-and-hyphens'); // 'some_mixed_string_with_spaces_underscores_and_hyphens'
 toSnakeCase('AllThe-small Things'); // "all_the_smal_things"
 toSnakeCase('IAmListeningToFMWhileLoadingDifferentURLOnMyBrowserAndAlsoEditingSomeXMLAndHTML'); // "i_am_listening_to_fm_while_loading_different_url_on_my_browser_and_also_editing_some_xml_and_html"

snippets/unescapeHTML.md

@@ -18,6 +18,7 @@ const unescapeHTML = str =>
       }[tag] || tag)
   );
 ```
+
 ```js
 unescapeHTML('&lt;a href=&quot;#&quot;&gt;Me &amp; you&lt;/a&gt;'); // '<a href="#">Me & you</a>'
 ```