From df84aa99cda88e7701d8f7b49e7b17db9c96b663 Mon Sep 17 00:00:00 2001 From: Ardalan Amini Date: Mon, 11 Feb 2019 04:33:52 +0330 Subject: [PATCH] Update docs --- docs/README.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/docs/README.md b/docs/README.md index 54694bbe..cd5d9ada 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1580,7 +1580,7 @@ Number.isNumber(2); // true * [.$dig(target)](#Object+$dig) ⇒ \* * [.$empty()](#Object+$empty) * [.$equals(obj)](#Object+$equals) ⇒ [Boolean](#Boolean) - * [.$flatten(obj)](#Object+$flatten) ⇒ [Object](#Object) + * [.$flatten()](#Object+$flatten) ⇒ [Object](#Object) * [.$forEach(fn)](#Object+$forEach) * [.$get(key)](#Object+$get) ⇒ \* * [.$invert()](#Object+$invert) ⇒ [Object](#Object) @@ -1712,15 +1712,10 @@ Performs a deep comparison between two values to determine if they are equivalen ``` -### object.$flatten(obj) ⇒ [Object](#Object) +### object.$flatten() ⇒ [Object](#Object) Flattens the object into a single-depth object **Kind**: instance method of [Object](#Object) - -| Param | Type | -| --- | --- | -| obj | [Object](#Object) | - **Example** ```javascript ({ foo: 1, bar: { foo: 2 } }).$flatten(); // { foo: 1, "bar.foo": 2 }