Skip to content

feat: remove lodash util functions #2115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kumilingus merged 9 commits into from
Apr 4, 2023
Merged

feat: remove lodash util functions #2115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f2f825a
feat(util): lodash helpers
MartinKanera Jan 19, 2023
c7e7e4d
feat(util): improved lodash util functions
MartinKanera Jan 23, 2023
f794bf5
feat: add lodash util tests
MartinKanera Jan 23, 2023
48ebd07
feat: minor utility adjustments
MartinKanera Jan 23, 2023
b5fe03e
feat(types.Util): improved type definitions
MartinKanera Jan 23, 2023
9bb7fb7
fix: tests
MartinKanera Jan 23, 2023
345b50c
feat: lodash util, tests and types adjustments
MartinKanera Feb 1, 2023
afecf05
feat(docs.util): update lodash documentation
MartinKanera Feb 17, 2023
5d09867
feat: remove lodash util functions
jamesgeorgewilliams Apr 4, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .eslintrc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@ module.exports = {
},
'env': {
'browser': true,
'node': true
'node': true,
'es6': true
},
'globals': {
'Uint8Array': true,
Expand Down
16 changes: 14 additions & 2 deletions docs/src/joint/api/util/assign.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
<pre class="docs-method-signature"><code>util.assign(destinationObject [, ...sourceObjects])</code></pre>
<p>(<i>Deprecated</i>) An alias for <b><code>_.assign</code></b>. See the <a href="https://lodash.com/docs/4.17.10#assign">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.assign(destinationObject, [...sourceObjects])</code></pre>
<p>Assigns own enumerable string keyed properties of source objects to the destination object. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources.</p>
<table>
<tr>
<th>destinationObject</th>
<td>Object</td>
<td>The destination object</td>
</tr>
<tr>
<th>[sourceObjects]</th>
<td>Object[]</td>
<td>The source objects</td>
</tr>
</table>
14 changes: 13 additions & 1 deletion docs/src/joint/api/util/bindAll.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
<pre class="docs-method-signature"><code>util.bindAll(object, methodNames)</code></pre>
<p>An alias for <b><code>_.bindAll</code></b>. See the <a href="https://lodash.com/docs/4.17.10#bindAll">Lodash documentation entry</a> for more information.</p>
<p>Binds methods of an object to the object itself, overwriting the existing method.</p>
<table>
<tr>
<th>object</th>
<td>Object</td>
<td>The object to bind and assign the bound methods to</td>
</tr>
<tr>
<th>methodNames</th>
<td>string|string[]</td>
<td>The object method names to bind</td>
</tr>
</table>
11 changes: 9 additions & 2 deletions docs/src/joint/api/util/camelCase.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
<pre class="docs-method-signature"><code>util.camelCase(string)</code></pre>
<p>An alias for <b><code>_.camelCase</code></b>. See the <a href="https://lodash.com/docs/4.17.10#camelCase">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.camelCase([string=''])</code></pre>
<p>Converts string to camel case.</p>
<table>
<tr>
<th>[string='']</th>
<td>string</td>
<td>The string to convert</td>
</tr>
</table>
9 changes: 8 additions & 1 deletion docs/src/joint/api/util/clone.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
<pre class="docs-method-signature"><code>util.clone(value)</code></pre>
<p>An alias for <b><code>_.clone</code></b>. See the <a href="https://lodash.com/docs/4.17.10#clone">Lodash documentation entry</a> for more information.</p>
<p>Creates a shallow clone of value.</p>
<table>
<tr>
<th>value</th>
<td>any</td>
<td>The value to clone</td>
</tr>
</table>
9 changes: 8 additions & 1 deletion docs/src/joint/api/util/cloneDeep.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
<pre class="docs-method-signature"><code>util.cloneDeep(value)</code></pre>
<p>An alias for <b><code>_.cloneDeep</code></b>. See the <a href="https://lodash.com/docs/4.17.10#cloneDeep">Lodash documentation entry</a> for more information.</p>
<p>This method is like <code>util.clone</code> except that it recursively clones value.</p>
<table>
<tr>
<th>value</th>
<td>any</td>
<td>The value to recursively clone</td>
</tr>
</table>
36 changes: 34 additions & 2 deletions docs/src/joint/api/util/debounce.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,34 @@
<pre class="docs-method-signature"><code>util.debounce(func [, wait, options])</code></pre>
<p>An alias for <b><code>_.debounce</code></b>. See the <a href="https://lodash.com/docs/4.17.10#debounce">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.debounce(func, [wait=0], [options={}])</code></pre>
<p>Creates a debounced function that delays invoking func until after wait milliseconds have elapsed since the last time the debounced function was invoked. The debounced function comes with a cancel method to cancel delayed func invocations and a flush method to immediately invoke them. Provide options to indicate whether func should be invoked on the leading and/or trailing edge of the wait timeout. The func is invoked with the last arguments provided to the debounced function. Subsequent calls to the debounced function return the result of the last func invocation.</p>
<table>
<tr>
<th>func</th>
<td>Function</td>
<td>The function to debounce</td>
</tr>
<tr>
<th>[wait=0]</th>
<td>number</td>
<td>The number of milliseconds to delay</td>
</tr>
<tr>
<th>[options={}]</th>
<td>Object</td>
<td>The options object</td>
</tr>
<tr>
<th>[options.leading=false]</th>
<td>boolean</td>
<td>Specify invoking on the leading edge of the timeout</td>
</tr>
<tr>
<th>[options.maxWait]</th>
<td>number</td>
<td>The maximum time func is allowed to be delayed before it's invoked</td>
</tr>
<tr>
<th>[options.trailing=true]</th>
<td>boolean</td>
<td>Specify invoking on the trailing edge of the timeout</td>
</tr>
</table>
4 changes: 2 additions & 2 deletions docs/src/joint/api/util/deepMixin.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<pre class="docs-method-signature"><code>util.deepMixin(destinationObject, sourceObject, options)</code></pre>
<p>(<i>Deprecated</i>) An alias for <b><code>_.mixin</code></b>. See the <a href="https://lodash.com/docs/4.17.10#mixin">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.deepMixin(destinationObject, [...sourceObjects])</code></pre>
<p>(<i>Deprecated</i>) An <a href="#util.assign">alias</a> for <code>util.assign</code>, use it instead.</p>
6 changes: 2 additions & 4 deletions docs/src/joint/api/util/deepSupplement.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,2 @@
<pre class="docs-method-signature"><code>util.deepSupplement(destinationObject [, ...sourceObjects])</code></pre>
<p>(<i>Deprecated</i>) An alias for <b><code>_.defaultsDeep</code></b>. See the <a href="https://lodash.com/docs/4.17.10#defaultsDeep">Lodash documentation entry</a> for more information.</p>

<p>Use the <code>util.defaultsDeep</code> <a href="#util.defaultsDeep">function</a> instead.</p>
<pre class="docs-method-signature"><code>util.deepSupplement(destinationObject [...sourceObjects])</code></pre>
<p>(<i>Deprecated</i>) An <a href="#util.defaultsDeep">alias</a> for <code>util.defaultsDeep</code>, use it instead.</p>
16 changes: 14 additions & 2 deletions docs/src/joint/api/util/defaults.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
<pre class="docs-method-signature"><code>util.defaults(destinationObject [, ...sourceObjects])</code></pre>
<p>An alias for <b><code>_.defaults</code></b>. See the <a href="https://lodash.com/docs/4.17.10#defaults">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.defaults(destinationObject [...sourceObjects])</code></pre>
<p>Assigns own and inherited enumerable string keyed properties of source objects to the destination object for all destination properties that resolve to undefined. Source objects are applied from left to right. Once a property is set, additional values of the same property are ignored.</p>
<table>
<tr>
<th>destinationObject</th>
<td>Object</td>
<td>The destination object</td>
</tr>
<tr>
<th>[sourceObjects]</th>
<td>Object[]</td>
<td>The source objects</td>
</tr>
</table>
16 changes: 14 additions & 2 deletions docs/src/joint/api/util/defaultsDeep.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
<pre class="docs-method-signature"><code>util.defaultsDeep(destinationObject [, ...sourceObjects])</code></pre>
<p>An alias for <b><code>_.defaultsDeep</code></b>. See the <a href="https://lodash.com/docs/4.17.10#defaultsDeep">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.defaultsDeep(destinationObject [...sourceObjects])</code></pre>
<p>This method is like <code>util.defaults</code> except that it recursively assigns default properties.</p>
<table>
<tr>
<th>destinationObject</th>
<td>Object</td>
<td>The destination object</td>
</tr>
<tr>
<th>[sourceObjects]</th>
<td>Object[]</td>
<td>The source objects</td>
</tr>
</table>
16 changes: 14 additions & 2 deletions docs/src/joint/api/util/difference.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
<pre class="docs-method-signature"><code>util.difference(array [, ...excludedValuesArrays])</code></pre>
<p>An alias for <b><code>_.difference</code></b>. See the <a href="https://lodash.com/docs/4.17.10#difference">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.difference(array, [...values])</code></pre>
<p>Creates an array of array values not included in the other given arrays using SameValueZero for equality comparisons. The order and references of result values are determined by the first array.</p>
<table>
<tr>
<th>array</th>
<td>any[]</td>
<td>The array to inspect</td>
</tr>
<tr>
<th>[values]</th>
<td>any[]</td>
<td>The values to exclude</td>
</tr>
</table>
9 changes: 8 additions & 1 deletion docs/src/joint/api/util/flattenDeep.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
<pre class="docs-method-signature"><code>util.flattenDeep(array)</code></pre>
<p>An alias for <b><code>_.flattenDeep</code></b>. See the <a href="https://lodash.com/docs/4.17.10#flattenDeep">Lodash documentation entry</a> for more information.</p>
<p>Recursively flattens array.</p>
<table>
<tr>
<th>array</th>
<td>any[]</td>
<td>The array to flatten</td>
</tr>
</table>
16 changes: 14 additions & 2 deletions docs/src/joint/api/util/forIn.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
<pre class="docs-method-signature"><code>util.forIn(object [, iteratee])</code></pre>
<p>An alias for <b><code>_.forIn</code></b>. See the <a href="https://lodash.com/docs/4.17.10#forIn">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.forIn(object, [iteratee])</code></pre>
<p>Iterates over elements of collection and invokes iteratee for each element. The iteratee is invoked with three arguments: (value, index|key, collection). Iteratee functions may exit iteration early by explicitly returning false.</p>
<table>
<tr>
<th>collection</th>
<td>any[]|Object</td>
<td>The collection to iterate over</td>
</tr>
<tr>
<th>[iteratee]</th>
<td>Function</td>
<td>The function invoked per iteration</td>
</tr>
</table>
16 changes: 14 additions & 2 deletions docs/src/joint/api/util/groupBy.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
<pre class="docs-method-signature"><code>util.groupBy(collection [, iteratee])</code></pre>
<p>An alias for <b><code>_.groupBy</code></b>. See the <a href="https://lodash.com/docs/4.17.10#groupBy">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.groupBy(collection, [iteratee])</code></pre>
<p>Creates an object composed of keys generated from the results of running each element of collection thru iteratee. The order of grouped values is determined by the order they occur in collection. The corresponding value of each key is an array of elements responsible for generating the key. The iteratee is invoked with one argument: <i>(value)</i>.</p>
<table>
<tr>
<th>collection</th>
<td>any[]|Object</td>
<td>The collection to iterate over</td>
</tr>
<tr>
<th>[iteratee]</th>
<td>Function</td>
<td>The function invoked per iteration</td>
</tr>
</table>
14 changes: 13 additions & 1 deletion docs/src/joint/api/util/has.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
<pre class="docs-method-signature"><code>util.has(object, propertyPath)</code></pre>
<p>An alias for <b><code>_.has</code></b>. See the <a href="https://lodash.com/docs/4.17.10#has">Lodash documentation entry</a> for more information.</p>
<p>Checks if path is a direct property of object.</p>
<table>
<tr>
<th>object</th>
<td>Object</td>
<td>The object to query</td>
</tr>
<tr>
<th>propertyPath</th>
<td>string[]|string</td>
<td>The path to check</td>
</tr>
</table>
9 changes: 8 additions & 1 deletion docs/src/joint/api/util/intersection.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
<pre class="docs-method-signature"><code>util.intersection([...arrays])</code></pre>
<p>An alias for <b><code>_.intersection</code></b>. See the <a href="https://lodash.com/docs/4.17.10#intersection">Lodash documentation entry</a> for more information.</p>
<p>Creates an array of unique values that are included in all given arrays using <a href="https://262.ecma-international.org/7.0/#sec-samevaluezero">SameValueZero</a> for equality comparisons. The order and references of result values are determined by the first array.</p>
<table>
<tr>
<th>[arrays]</th>
<td>any[][]</td>
<td>The arrays to inspect</td>
</tr>
</table>
23 changes: 19 additions & 4 deletions docs/src/joint/api/util/invoke.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,19 @@
<pre class="docs-method-signature"><code>util.invoke(collection, methodPath [, args])</code></pre>
<pre class="docs-method-signature"><code>util.invoke(collection, functionToInvokeForAll [, args])</code></pre>

<p>An alias for <b><code>_.invokeMap</code></b>. See the <a href="https://lodash.com/docs/4.17.10#invokeMap">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.invoke(collection, path, [args])</code></pre>
<p>Invokes the method at path of each element in collection, returning an array of the results of each invoked method. Any additional arguments are provided to each invoked method. If path is a function, it's invoked for, and this bound to, each element in collection.</p>
<table>
<tr>
<th>collection</th>
<td>any[]|Object</td>
<td>The collection to iterate over</td>
</tr>
<tr>
<th>path</th>
<td>string[]|string|Function</td>
<td>The path of the method to invoke or the function invoked per iteration</td>
</tr>
<tr>
<th>[args]</th>
<td>any[]</td>
<td>The arguments to invoke each method with</td>
</tr>
</table>
19 changes: 19 additions & 0 deletions docs/src/joint/api/util/invokeProperty.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<pre class="docs-method-signature"><code>util.invokeProperty(object, path, [args])</code></pre>
<p>Invokes the method at path of object.</p>
<table>
<tr>
<th>object</th>
<td>Object</td>
<td>The object to query</td>
</tr>
<tr>
<th>path</th>
<td>string[]|string</td>
<td>The path of the method to invoke</td>
</tr>
<tr>
<th>[args]</th>
<td>any[]</td>
<td>The arguments to invoke the method with</td>
</tr>
</table>
11 changes: 10 additions & 1 deletion docs/src/joint/api/util/isEmpty.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,11 @@
<pre class="docs-method-signature"><code>util.isEmpty(value)</code></pre>
<p>An alias for <b><code>_.isEmpty</code></b>. See the <a href="https://lodash.com/docs/4.17.10#isEmpty">Lodash documentation entry</a> for more information.</p>
<p>Checks if value is an empty object, collection, map, or set.</p>
<p>Objects are considered empty if they have no own enumerable string keyed properties.</p>
<p>Array-like values such as arguments objects, arrays, strings, or jQuery-like collections are considered empty if they have a length of 0. Similarly, maps and sets are considered empty if they have a size of 0.</p>
<table>
<tr>
<th>value</th>
<td>any</td>
<td>The value to check</td>
</tr>
</table>
14 changes: 13 additions & 1 deletion docs/src/joint/api/util/isEqual.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
<pre class="docs-method-signature"><code>util.isEqual(value, otherValue)</code></pre>
<p>An alias for <b><code>_.isEqual</code></b>. See the <a href="https://lodash.com/docs/4.17.10#isEqual">Lodash documentation entry</a> for more information.</p>
<p>Performs a deep comparison between two values to determine if they are equivalent.</p>
<table>
<tr>
<th>value</th>
<td>any</td>
<td>The value to compare</td>
</tr>
<tr>
<th>otherValue</th>
<td>any</td>
<td>The other value to compare</td>
</tr>
</table>
9 changes: 8 additions & 1 deletion docs/src/joint/api/util/isFunction.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
<pre class="docs-method-signature"><code>util.isFunction(value)</code></pre>
<p>An alias for <b><code>_.isFunction</code></b>. See the <a href="https://lodash.com/docs/4.17.10#isFunction">Lodash documentation entry</a> for more information.</p>
<p>Checks if value is classified as a Function object.</p>
<table>
<tr>
<th>value</th>
<td>any</td>
<td>The value to check</td>
</tr>
</table>
9 changes: 8 additions & 1 deletion docs/src/joint/api/util/isPlainObject.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,9 @@
<pre class="docs-method-signature"><code>util.isPlainObject(value)</code></pre>
<p>An alias for <b><code>_.isPlainObject</code></b>. See the <a href="https://lodash.com/docs/4.17.10#isPlainObject">Lodash documentation entry</a> for more information.</p>
<p>Checks if value is a plain object, that is, an object created by the Object constructor or one with a [[Prototype]] of null.</p>
<table>
<tr>
<th>value</th>
<td>any</td>
<td>The value to check</td>
</tr>
</table>
21 changes: 19 additions & 2 deletions docs/src/joint/api/util/merge.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,19 @@
<pre class="docs-method-signature"><code>util.merge(destinationObject, ...sourceObjects [, customizer])</code></pre>
<p>An alias for <b><code>_.mergeWith</code></b>. See the <a href="https://lodash.com/docs/4.17.10#mergeWith">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.merge(destinationObject, [...sourceObjects], [customizer])</code></pre>
<p>This method is like <code>joint.util.assign</code> except that it recursively merges own and inherited enumerable string keyed properties of source objects into the destination object. Source properties that resolve to undefined are skipped if a destination value exists. Array and plain object properties are merged recursively. Other objects and value types are overridden by assignment. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources. In addition this method accepts a customizer which is invoked to produce the merged values of the destination and source properties. The customizer is invoked with six arguments: <i>(objValue, srcValue, key, object, source, stack)</i></p>
<table>
<tr>
<th>destinationObject</th>
<td>Object</td>
<td>The destination object</td>
</tr>
<tr>
<th>[sourceObjects]</th>
<td>Object[]</td>
<td>The source objects</td>
</tr>
<tr>
<th>customizer</th>
<td>Function</td>
<td>The function to customize assigned values</td>
</tr>
</table>
4 changes: 2 additions & 2 deletions docs/src/joint/api/util/mixin.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<pre class="docs-method-signature"><code>util.mixin(destinationObject [, ...sourceObjects])</code></pre>
<p>(<i>Deprecated</i>) An alias for <b><code>_.assign</code></b> (not <code>_.mixin</code>). See the <a href="https://lodash.com/docs/4.17.10#assign">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.mixin(destinationObject, [...sourceObjects])</code></pre>
<p>(<i>Deprecated</i>) An <a href="#util.assign">alias</a> for <code>util.assign</code>, use it instead.</p>
16 changes: 14 additions & 2 deletions docs/src/joint/api/util/omit.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,2 +1,14 @@
<pre class="docs-method-signature"><code>util.omit(object [, ...propertyPathsToOmit])</code></pre>
<p>An alias for <b><code>_.omit</code></b>. See the <a href="https://lodash.com/docs/4.17.10#omit">Lodash documentation entry</a> for more information.</p>
<pre class="docs-method-signature"><code>util.omit(object, [...paths])</code></pre>
<p>Opposite of <code>util.pick</code>, this method creates an object composed of the own and inherited enumerable property paths of object that are not omitted.</p>
<table>
<tr>
<th>object</th>
<td>Object</td>
<td>The source object</td>
</tr>
<tr>
<th>[paths]</th>
<td>string[]|string[][]</td>
<td>The property paths to omit</td>
</tr>
</table>
Loading