Patch bugs (#4)

* Fix copy paste errors * Reorder unset definitions
Siegrift · Jun 4, 2019 · fa91958 · fa91958
1 parent c14e1fd
commit fa91958
Show file tree

Hide file tree

Showing 13 changed files with 262 additions and 141 deletions.
diff --git a/docs/globals.html b/docs/globals.html
diff --git a/docs/index.html b/docs/index.html
@@ -196,6 +196,9 @@ <h2 id="limitations">Limitations</h2>
 					<li class=" tsd-kind-function">
 						<a href="globals.html#isnullorundefined" class="tsd-kind-icon">is<wbr>Null<wbr>OrUndefined</a>
 					</li>
+					<li class=" tsd-kind-function">
+						<a href="globals.html#isobject" class="tsd-kind-icon">is<wbr>Object</a>
+					</li>
 					<li class=" tsd-kind-function tsd-has-type-parameter">
 						<a href="globals.html#map" class="tsd-kind-icon">map</a>
 					</li>

diff --git a/docs/interfaces/dictionary.html b/docs/interfaces/dictionary.html
@@ -161,6 +161,9 @@ <h3 class="tsd-before-signature">Indexable</h3>
 					<li class=" tsd-kind-function">
 						<a href="../globals.html#isnullorundefined" class="tsd-kind-icon">is<wbr>Null<wbr>OrUndefined</a>
 					</li>
+					<li class=" tsd-kind-function">
+						<a href="../globals.html#isobject" class="tsd-kind-icon">is<wbr>Object</a>
+					</li>
 					<li class=" tsd-kind-function tsd-has-type-parameter">
 						<a href="../globals.html#map" class="tsd-kind-icon">map</a>
 					</li>

diff --git a/docs/interfaces/numericdictionary.html b/docs/interfaces/numericdictionary.html
@@ -161,6 +161,9 @@ <h3 class="tsd-before-signature">Indexable</h3>
 					<li class=" tsd-kind-function">
 						<a href="../globals.html#isnullorundefined" class="tsd-kind-icon">is<wbr>Null<wbr>OrUndefined</a>
 					</li>
+					<li class=" tsd-kind-function">
+						<a href="../globals.html#isobject" class="tsd-kind-icon">is<wbr>Object</a>
+					</li>
 					<li class=" tsd-kind-function tsd-has-type-parameter">
 						<a href="../globals.html#map" class="tsd-kind-icon">map</a>
 					</li>

diff --git a/src/lib/exist.ts b/src/lib/exist.ts
@@ -1,5 +1,6 @@
 import { Optional, U } from '../types'
 import { isNullOrUndefined } from 'util'
+import { isObject } from '../utils'
 
 /**
  * Checks whether path exist in source value.
@@ -101,7 +102,7 @@ export function exist(source: any, path: any[]) {
   while (++index < path.length) {
     if (
       isNullOrUndefined(source) ||
-      typeof source !== 'object' ||
+      !isObject(source) ||
       !source.hasOwnProperty(path[index])
     ) {
       return false

diff --git a/src/lib/set.ts b/src/lib/set.ts
@@ -1,5 +1,6 @@
 import { Optional, U } from '../types'
 import { shallowCopy } from '../utils'
+import { isObject } from 'util'
 
 /**
  * Sets the value on the specified path in source value. If the path in the source doesn't exist it
@@ -122,13 +123,13 @@ export function set<
 
 // NOTE: implementation
 export function set(source: any, path: any[], value: any) {
-  const returnObject = shallowCopy(source, Array.isArray(path[0]) ? [] : {})
+  const returnObject = shallowCopy(source, Number.isInteger(path[0]) ? [] : {})
   let currentObject = returnObject
   let index = 0
   while (index < path.length) {
     if (
       !Array.isArray(currentObject[path[index]]) &&
-      typeof currentObject[path[index]] !== 'object'
+      !isObject(currentObject[path[index]])
     ) {
       currentObject[path[index]] = Number.isInteger(path[index + 1]) ? [] : {}
     }

diff --git a/src/lib/unset.ts b/src/lib/unset.ts
@@ -32,9 +32,9 @@ type Unset5<T, K1, K2, K3, K4, K5> = {
  * @returns source value with removed value
  */
 export function unset<T, K1 extends keyof T>(
-  source: Nullable<T>,
+  source: T,
   path: [K1],
-): Nullable<Unset1<T, K1>>
+): Unset1<T, K1>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -51,9 +51,9 @@ export function unset<T, K1 extends keyof T>(
  * @returns source value with removed value
  */
 export function unset<T, K1 extends keyof T, K2 extends keyof U<T[K1]>>(
-  source: Nullable<T>,
+  source: T,
   path: [K1, K2],
-): Nullable<Unset2<T, K1, K2>>
+): Unset2<T, K1, K2>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -74,7 +74,7 @@ export function unset<
   K1 extends keyof T,
   K2 extends keyof U<T[K1]>,
   K3 extends keyof U<U<T[K1]>[K2]>
->(source: Nullable<T>, path: [K1, K2, K3]): Nullable<Unset3<T, K1, K2, K3>>
+>(source: T, path: [K1, K2, K3]): Unset3<T, K1, K2, K3>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -96,10 +96,7 @@ export function unset<
   K2 extends keyof U<T[K1]>,
   K3 extends keyof U<U<T[K1]>[K2]>,
   K4 extends keyof U<U<U<T[K1]>[K2]>[K3]>
->(
-  source: Nullable<T>,
-  path: [K1, K2, K3, K4],
-): Nullable<Unset4<T, K1, K2, K3, K4>>
+>(source: T, path: [K1, K2, K3, K4]): Unset4<T, K1, K2, K3, K4>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -122,10 +119,7 @@ export function unset<
   K3 extends keyof U<U<T[K1]>[K2]>,
   K4 extends keyof U<U<U<T[K1]>[K2]>[K3]>,
   K5 extends keyof U<U<U<U<T[K1]>[K2]>[K3]>[K4]>
->(
-  source: Nullable<T>,
-  path: [K1, K2, K3, K4, K5],
-): Nullable<Unset5<T, K1, K2, K3, K4, K5>>
+>(source: T, path: [K1, K2, K3, K4, K5]): Unset5<T, K1, K2, K3, K4, K5>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -142,9 +136,9 @@ export function unset<
  * @returns source value with removed value
  */
 export function unset<T, K1 extends keyof T>(
-  source: Undefinable<T>,
+  source: Nullable<T>,
   path: [K1],
-): Undefinable<Unset1<T, K1>>
+): Nullable<Unset1<T, K1>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -161,9 +155,9 @@ export function unset<T, K1 extends keyof T>(
  * @returns source value with removed value
  */
 export function unset<T, K1 extends keyof T, K2 extends keyof U<T[K1]>>(
-  source: Undefinable<T>,
+  source: Nullable<T>,
   path: [K1, K2],
-): Undefinable<Unset2<T, K1, K2>>
+): Nullable<Unset2<T, K1, K2>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -184,10 +178,7 @@ export function unset<
   K1 extends keyof T,
   K2 extends keyof U<T[K1]>,
   K3 extends keyof U<U<T[K1]>[K2]>
->(
-  source: Undefinable<T>,
-  path: [K1, K2, K3],
-): Undefinable<Unset3<T, K1, K2, K3>>
+>(source: Nullable<T>, path: [K1, K2, K3]): Nullable<Unset3<T, K1, K2, K3>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -210,9 +201,9 @@ export function unset<
   K3 extends keyof U<U<T[K1]>[K2]>,
   K4 extends keyof U<U<U<T[K1]>[K2]>[K3]>
 >(
-  source: Undefinable<T>,
+  source: Nullable<T>,
   path: [K1, K2, K3, K4],
-): Undefinable<Unset4<T, K1, K2, K3, K4>>
+): Nullable<Unset4<T, K1, K2, K3, K4>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -236,9 +227,9 @@ export function unset<
   K4 extends keyof U<U<U<T[K1]>[K2]>[K3]>,
   K5 extends keyof U<U<U<U<T[K1]>[K2]>[K3]>[K4]>
 >(
-  source: Undefinable<T>,
+  source: Nullable<T>,
   path: [K1, K2, K3, K4, K5],
-): Undefinable<Unset5<T, K1, K2, K3, K4, K5>>
+): Nullable<Unset5<T, K1, K2, K3, K4, K5>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -255,9 +246,9 @@ export function unset<
  * @returns source value with removed value
  */
 export function unset<T, K1 extends keyof T>(
-  source: Optional<T>,
+  source: Undefinable<T>,
   path: [K1],
-): Optional<Unset1<T, K1>>
+): Undefinable<Unset1<T, K1>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -274,9 +265,9 @@ export function unset<T, K1 extends keyof T>(
  * @returns source value with removed value
  */
 export function unset<T, K1 extends keyof T, K2 extends keyof U<T[K1]>>(
-  source: Optional<T>,
+  source: Undefinable<T>,
   path: [K1, K2],
-): Optional<Unset2<T, K1, K2>>
+): Undefinable<Unset2<T, K1, K2>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -297,7 +288,10 @@ export function unset<
   K1 extends keyof T,
   K2 extends keyof U<T[K1]>,
   K3 extends keyof U<U<T[K1]>[K2]>
->(source: Optional<T>, path: [K1, K2, K3]): Optional<Unset3<T, K1, K2, K3>>
+>(
+  source: Undefinable<T>,
+  path: [K1, K2, K3],
+): Undefinable<Unset3<T, K1, K2, K3>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -320,9 +314,9 @@ export function unset<
   K3 extends keyof U<U<T[K1]>[K2]>,
   K4 extends keyof U<U<U<T[K1]>[K2]>[K3]>
 >(
-  source: Optional<T>,
+  source: Undefinable<T>,
   path: [K1, K2, K3, K4],
-): Optional<Unset4<T, K1, K2, K3, K4>>
+): Undefinable<Unset4<T, K1, K2, K3, K4>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -346,9 +340,9 @@ export function unset<
   K4 extends keyof U<U<U<T[K1]>[K2]>[K3]>,
   K5 extends keyof U<U<U<U<T[K1]>[K2]>[K3]>[K4]>
 >(
-  source: Optional<T>,
+  source: Undefinable<T>,
   path: [K1, K2, K3, K4, K5],
-): Optional<Unset5<T, K1, K2, K3, K4, K5>>
+): Undefinable<Unset5<T, K1, K2, K3, K4, K5>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -365,9 +359,9 @@ export function unset<
  * @returns source value with removed value
  */
 export function unset<T, K1 extends keyof T>(
-  source: T,
+  source: Optional<T>,
   path: [K1],
-): Unset1<T, K1>
+): Optional<Unset1<T, K1>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -384,9 +378,9 @@ export function unset<T, K1 extends keyof T>(
  * @returns source value with removed value
  */
 export function unset<T, K1 extends keyof T, K2 extends keyof U<T[K1]>>(
-  source: T,
+  source: Optional<T>,
   path: [K1, K2],
-): Unset2<T, K1, K2>
+): Optional<Unset2<T, K1, K2>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -407,7 +401,7 @@ export function unset<
   K1 extends keyof T,
   K2 extends keyof U<T[K1]>,
   K3 extends keyof U<U<T[K1]>[K2]>
->(source: T, path: [K1, K2, K3]): Unset3<T, K1, K2, K3>
+>(source: Optional<T>, path: [K1, K2, K3]): Optional<Unset3<T, K1, K2, K3>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -429,7 +423,10 @@ export function unset<
   K2 extends keyof U<T[K1]>,
   K3 extends keyof U<U<T[K1]>[K2]>,
   K4 extends keyof U<U<U<T[K1]>[K2]>[K3]>
->(source: T, path: [K1, K2, K3, K4]): Unset4<T, K1, K2, K3, K4>
+>(
+  source: Optional<T>,
+  path: [K1, K2, K3, K4],
+): Optional<Unset4<T, K1, K2, K3, K4>>
 
 /**
  * Removes the value on the specified path in source value. If the value is an array, the behavior
@@ -452,7 +449,10 @@ export function unset<
   K3 extends keyof U<U<T[K1]>[K2]>,
   K4 extends keyof U<U<U<T[K1]>[K2]>[K3]>,
   K5 extends keyof U<U<U<U<T[K1]>[K2]>[K3]>[K4]>
->(source: T, path: [K1, K2, K3, K4, K5]): Unset5<T, K1, K2, K3, K4, K5>
+>(
+  source: Optional<T>,
+  path: [K1, K2, K3, K4, K5],
+): Optional<Unset5<T, K1, K2, K3, K4, K5>>
 
 // NOTE: implementation
 export function unset(source: any, path: any[]) {

diff --git a/src/lib/update.ts b/src/lib/update.ts
@@ -1,5 +1,6 @@
 import { DeepReadonly, Optional, U } from '../types'
 import { shallowCopy } from '../utils'
+import { isObject } from 'util'
 
 /**
  * Updates the value on the specified path in source value using update function. This function will
@@ -140,13 +141,13 @@ export function update<
 
 // NOTE: implementation
 export function update(source: any, path: any[], updateFn: any) {
-  const returnObject = shallowCopy(source, Array.isArray(path[0]) ? [] : {})
+  const returnObject = shallowCopy(source, Number.isInteger(path[0]) ? [] : {})
   let currentObject = returnObject
   let index = 0
   while (index < path.length) {
     if (
       !Array.isArray(currentObject[path[index]]) &&
-      typeof currentObject[path[index]] !== 'object'
+      !isObject(currentObject[path[index]])
     ) {
       currentObject[path[index]] = Number.isInteger(path[index + 1]) ? [] : {}
     }

diff --git a/src/test/set.test.ts b/src/test/set.test.ts
@@ -85,14 +85,21 @@ describe('set', () => {
       })
     })
 
-    test('if path is number an array is created, otherwise object is created', () => {
-      type A = string[]
-      type D = { [key: string]: A }
-      type T = { req: { opt?: D | null } }
-      const obj: T = { req: { opt: null } }
+    describe('if path is number an array is created, otherwise object is created', () => {
+      test('correct root value', () => {
+        expect(set(null as any, ['hello'], 'str')).toEqual({ hello: 'str' })
+        expect(set(null as any, [1], 'str')).toEqual([undefined, 'str'])
+      })
+
+      test('deep path', () => {
+        type A = string[]
+        type D = { [key: string]: A }
+        type T = { req: { opt?: D | null } }
+        const obj: T = { req: { opt: null } }
 
-      expect(set(obj, ['req', 'opt', 'key', 1], 'str')).toEqual({
-        req: { opt: { key: [undefined, 'str'] } },
+        expect(set(obj, ['req', 'opt', 'key', 1], 'str')).toEqual({
+          req: { opt: { key: [undefined, 'str'] } },
+        })
       })
     })
   })

diff --git a/src/test/update.test.ts b/src/test/update.test.ts
@@ -101,14 +101,26 @@ describe('update', () => {
       })
     })
 
-    test('if path is number an array is created, otherwise object is created', () => {
-      type A = string[]
-      type D = { [key: string]: A }
-      type T = { req: { opt?: D | null } }
-      const obj: T = { req: { opt: null } }
+    describe('if path is number an array is created, otherwise object is created', () => {
+      test('correct root value', () => {
+        expect(update(null as any, ['hello'], () => 'str')).toEqual({
+          hello: 'str',
+        })
+        expect(update(null as any, [1], () => 'str')).toEqual([
+          undefined,
+          'str',
+        ])
+      })
+
+      test('deep path', () => {
+        type A = string[]
+        type D = { [key: string]: A }
+        type T = { req: { opt?: D | null } }
+        const obj: T = { req: { opt: null } }
 
-      expect(update(obj, ['req', 'opt', 'key', 1], () => 'str')).toEqual({
-        req: { opt: { key: [undefined, 'str'] } },
+        expect(update(obj, ['req', 'opt', 'key', 1], () => 'str')).toEqual({
+          req: { opt: { key: [undefined, 'str'] } },
+        })
       })
     })
   })

diff --git a/src/types.ts b/src/types.ts
@@ -8,7 +8,7 @@ export type DeepReadonlyObject<T> = {
 
 export type Nullable<T> = T | null
 
-export type Undefinable<T> = T | null
+export type Undefinable<T> = T | undefined
 
 export type Optional<T> = T | null | undefined