Merge pull request #4140 from pocesar/object-path

fix and simplify declarations

object-path/object-path-tests.ts

@@ -23,20 +23,26 @@ obj.get(array);
 obj.set(array, 'value');
 obj.insert(1, 10);
 
-objectPath.del<string[]>(array) === ['12'];
-objectPath.del<typeof object>(object) === object;
+objectPath.del(object, array) === object;
+objectPath.del(object, [1,2]) === object;
+objectPath.del(object, [1,'2']) === object;
+objectPath.del(object, 1) === object;
+objectPath.del(object, '1') === object;
 objectPath.del(object) === object;
 obj.del() === object;
 
 objectPath.has(object, ['1','2','3']) === true;
 objectPath.has(object, ['1.2.3']) === false;
 objectPath.has(object, [1,2,3]) === true;
+objectPath.has(object, [1,'2',3]) === true;
 objectPath.has(object, 1) === false;
+objectPath.has(object, '1') === false;
 objectPath.has() === false;
 
 objectPath.del() === void 0;
 objectPath.del(object, ['1','2','3']);
 objectPath.del(object, [1,2,3]);
+objectPath.del(object, [1,'2',3]);
 objectPath.del(object, 1);
 objectPath.del(object, 'one').one === 1;
 obj.del('one').one === 1;
@@ -45,13 +51,15 @@ objectPath.coalesce(object, ['1','2']) === void 0;
 objectPath.coalesce(object, ['1',['2','1']]) === void 0;
 objectPath.coalesce(object, ['1',['2','1']], 1) === 1;
 objectPath.coalesce(object, [1,1], 1) === 1;
-objectPath.coalesce(object, <Array<number[]>>[1,[1,1]], 1) === 1;
-obj.coalesce(<Array<number[]>>[1,[1,1]], 1) === 1;
+objectPath.coalesce(object, [1,'1'], 1) === 1;
+objectPath.coalesce(object, [1,[1,1],'1',[1,'1']], 1) === 1;
+obj.coalesce([1,[1,1],'1',['1',1]], 1) === 1;
 
 objectPath.ensureExists(object, '1.2', 2);
 objectPath.ensureExists(object, 1, 2);
 objectPath.ensureExists(object, [1,2], 2);
 objectPath.ensureExists(object, ['1','2'], 2);
+objectPath.ensureExists(object, ['1',2], 2);
 objectPath.ensureExists<typeof object, number>(object, ['1','2'], 2) === 3;
 objectPath.ensureExists<typeof object, any[][]>(object, ['1','2'], 2) === [[]];
 obj.ensureExists<any[][]>(['1','2'], 2) === [[]];
@@ -60,7 +68,9 @@ objectPath.push(object, 1, 1,2,3,4);
 objectPath.push(object, 1, 1,'2', 3, false);
 objectPath.push(object, 'one.four', 1,'2', 3, false);
 objectPath.push(object, ['one','two'], [1,'2', 3, false]);
+objectPath.push(object, [1, 'two'], [1,'2', 3, false]);
 obj.push(['one','two'], [1,'2', 3, false]);
+obj.push(['one', 2], [1,'2', 3, false]);
 
 objectPath.get(array) === array;
 objectPath.get(Null) === Null;
@@ -73,16 +83,20 @@ objectPath.get(object, 0, 3) === 3;
 objectPath.get(object, 0, '3') === '3';
 objectPath.get<typeof object, string[]>(object, 0, ['1','2']) === ['1','2'];
 objectPath.get<typeof object, number>(object, 0) === 10;
-obj.get<number>(0) === 10;
+objectPath.get<typeof object, number>(object, 0) === 10;
+obj.get(0, 10) === 10;
 
 objectPath.set(object, '1.2', true);
 objectPath.set(object, ['1','2'], true);
 objectPath.set(object, [1, 2], true);
+objectPath.set(object, [1, '2'], true);
 objectPath.set(object, '1.2', true, true);
 objectPath.set(object, '1.2', true, false);
 objectPath.set<typeof object, string[]>(object, '1.2', true, false) === ['string'];
 objectPath.set<typeof object, typeof object>(object, '1.2', true, false) === object;
 obj.set<typeof object>('1.2', true, false) === object;
+obj.set<typeof object>(['1','2'], true, false) === object;
+obj.set<typeof object>(['1', 2], true, false) === object;
 
 objectPath.insert(object, '1.2', 1);
 objectPath.insert(object, ['1','2'], 1);
@@ -90,5 +104,8 @@ objectPath.insert(object, 1, 1);
 objectPath.insert(object, [1,2], 1);
 objectPath.insert(object, '1.2', 1, 2);
 objectPath.insert(object, ['1.2'], 1, 6);
+objectPath.insert(object, ['1',2], 1, 6);
 obj.insert(['1.2'], 1, 6);
-
+obj.insert(1, 1, 6);
+obj.insert(['1',1], 1, 6);
+obj.insert('1', 1, 6);

object-path/object-path.d.ts

@@ -3,17 +3,12 @@
 // Definitions by: Paulo Cesar <https://github.com/pocesar/>
 // Definitions: https://github.com/borisyankov/DefinitelyTyped
 
-declare var objectPath: objectPath.IObjectPathStatic;
+declare var objectPath: ObjectPathGlobal.IObjectPathStatic;
 
-declare module objectPath {
+declare module ObjectPathGlobal {
 
-    interface IStringArray {
-        [index: number]: string;
-    }
-
-    interface INumberArray {
-        [index: number]: number;
-    }
+    type IPath = Array<number|string>|number|string;
+    type IMultiArray = Array<IPath>;
 
     interface IObjectPathStatic {
         /**
@@ -29,23 +24,11 @@ declare module objectPath {
          * @param {string[]|string} path
          * @return object
          */
-        del<T extends {}>(object: T, path: IStringArray): T;
+        del<T extends {}>(object: T, path: IPath): T;
         /**
          * @see objectPath.del
          */
-        del<T extends {}>(object: T, path: INumberArray): T;
-        /**
-         * @see objectPath.del
-         */
-        del<T extends {}>(object: T, path: number): T;
-        /**
-         * @see objectPath.del
-         */
-        del<T extends {}>(object: T, path: string): T;
-        /**
-         * @see objectPath.del
-         */
-        del<T extends {}>(object: T): T;
+        del<T extends {}>(object: T):T;
         /**
          * @see objectPath.del
          */
@@ -58,19 +41,7 @@ declare module objectPath {
          * @param {string[]|string} path
          * @return object
          */
-        has<T extends {}>(object: T, path: IStringArray): boolean;
-        /**
-         * @see objectPath.has
-         */
-        has<T extends {}>(object: T, path: INumberArray): boolean;
-        /**
-         * @see objectPath.has
-         */
-        has<T extends {}>(object: T, path: string): boolean;
-        /**
-         * @see objectPath.has
-         */
-        has<T extends {}>(object: T, path: number): boolean;
+        has<T extends {}>(object: T, path: IPath): boolean;
         /**
          * @see objectPath.has
          */
@@ -87,19 +58,7 @@ declare module objectPath {
          * @param {string|string[]|number|number[]} path
          * @param {*} [defaultValue=undefined]
          */
-        get<T extends {}, TResult>(object: T, path: string, defaultValue?: TResult): TResult;
-        /**
-         * @see objectPath.get
-         */
-        get<T extends {}, TResult>(object: T, path: IStringArray, defaultValue?: TResult): TResult;
-        /**
-         * @see objectPath.get
-         */
-        get<T extends {}, TResult>(object: T, path: number, defaultValue?: TResult): TResult;
-        /**
-         * @see objectPath.get
-         */
-        get<T extends {}, TResult>(object: T, path: INumberArray, defaultValue?: TResult): TResult;
+        get<T extends {}, TResult>(object: T, path: IPath, defaultValue?: TResult): TResult;
         /**
          * @see objectPath.get
          */
@@ -118,19 +77,7 @@ declare module objectPath {
          * @param {boolean} [doNotReplace=false]
          * @return Any existing value on the path if any
          */
-        set<T extends {}, TExisting>(object: T, path: string, value: any, doNotReplace?:boolean): TExisting;
-        /**
-         * @see objectPath.set
-         */
-        set<T extends {}, TExisting>(object: T, path: number, value: any, doNotReplace?:boolean): TExisting;
-        /**
-         * @see objectPath.set
-         */
-        set<T extends {}, TExisting>(object: T, path: IStringArray, value: any, doNotReplace?:boolean): TExisting;
-        /**
-         * @see objectPath.set
-         */
-        set<T extends {}, TExisting>(object: T, path: INumberArray, value: any, doNotReplace?:boolean): TExisting;
+        set<T extends {}, TExisting>(object: T, path: IPath, value: any, doNotReplace?:boolean): TExisting;
         /**
          * @see objectPath.set
          */
@@ -145,19 +92,7 @@ declare module objectPath {
          * Create (if path isn't an array) and push the value to it. Can push unlimited number of values
          * @param {object} object
          */
-        push<T extends {}>(object: T, path: INumberArray, ...args:any[]):void;
-        /**
-         * @see objectPath.push
-         */
-        push<T extends {}>(object: T, path: IStringArray, ...args:any[]):void;
-        /**
-         * @see objectPath.push
-         */
-        push<T extends {}>(object: T, path: number, ...args:any[]):void;
-        /**
-         * @see objectPath.push
-         */
-        push<T extends {}>(object: T, path: string, ...args:any[]):void;
+        push<T extends {}>(object: T, path: IPath, ...args:any[]):void;
         /**
          * @see objectPath.push
          */
@@ -171,19 +106,7 @@ declare module objectPath {
          * @param {*} defaultValue
          * @return {*}
          */
-        coalesce<T extends {}, TResult>(object: T, paths: IStringArray, defaultValue?: any):TResult;
-        /**
-         * @see objectPath.coalesce
-         */
-        coalesce<T extends {}, TResult>(object: T, paths: INumberArray, defaultValue?: any):TResult;
-        /**
-         * @see objectPath.coalesce
-         */
-        coalesce<T extends {}, TResult>(object: T, paths: IStringArray[], defaultValue?: any):TResult;
-        /**
-         * @see objectPath.coalesce
-         */
-        coalesce<T extends {}, TResult>(object: T, paths: INumberArray[], defaultValue?: any):TResult;
+        coalesce<T extends {}, TResult>(object: T, paths: IMultiArray, defaultValue?: TResult):TResult;
 
         /*======== Empty =========*/
         /**
@@ -192,19 +115,7 @@ declare module objectPath {
          * @param {object} object
          * @param {string|string[]|number[]} path
          */
-        empty<T extends {}, TResult>(object: T, path: string):TResult;
-        /**
-         * @see objectPath.empty
-         */
-        empty<T extends {}, TResult>(object: T, path: INumberArray):TResult;
-        /**
-         * @see objectPath.empty
-         */
-        empty<T extends {}, TResult>(object: T, path: IStringArray):TResult;
-        /**
-         * @see objectPath.empty
-         */
-        empty<T extends {}, TResult>(object: T, path: number):TResult;
+        empty<T extends {}, TResult>(object: T, path: IPath):TResult;
         /**
          * @see objectPath.empty
          */
@@ -220,19 +131,7 @@ declare module objectPath {
          * @param {object} object
          * @param {string|string[]|number|number[]} path
          */
-        ensureExists<T extends {}, TResult>(object: T, path: string, value: any):TResult;
-        /**
-         * @see objectPath.ensureExists
-         */
-        ensureExists<T extends {}, TResult>(object: T, path: number, value: any):TResult;
-        /**
-         * @see objectPath.ensureExists
-         */
-        ensureExists<T extends {}, TResult>(object: T, path: INumberArray, value: any):TResult;
-        /**
-         * @see objectPath.ensureExists
-         */
-        ensureExists<T extends {}, TResult>(object: T, path: IStringArray, value: any):TResult;
+        ensureExists<T extends {}, TExisting>(object: T, path: IPath, value: any):TExisting;
         /**
          * @see objectPath.ensureExists
          */
@@ -250,19 +149,7 @@ declare module objectPath {
          * @param {*} value
          * @param {number} [at=0]
          */
-        insert<T extends {}>(object: T, path: string, value: any, at?: number):void;
-        /**
-         * @see objectPath.insert
-         */
-        insert<T extends {}>(object: T, path: INumberArray, value: any, at?: number):void;
-        /**
-         * @see objectPath.insert
-         */
-        insert<T extends {}>(object: T, path: IStringArray, value: any, at?: number):void;
-        /**
-         * @see objectPath.insert
-         */
-        insert<T extends {}>(object: T, path: number, value: any, at?: number):void;
+        insert<T extends {}>(object: T, path: IPath, value: any, at?: number):void;
     }
 
     interface IObjectPathBound<T extends {}> {
@@ -271,19 +158,7 @@ declare module objectPath {
         /**
          * @see objectPath.ensureExists
          */
-        del(path: IStringArray): T;
-        /**
-         * @see objectPath.del
-         */
-        del(path: INumberArray): T;
-        /**
-         * @see objectPath.del
-         */
-        del(path: number): T;
-        /**
-         * @see objectPath.del
-         */
-        del(path: string): T;
+        del(path: IPath): T;
         /**
          * @see objectPath.del
          */
@@ -293,19 +168,7 @@ declare module objectPath {
         /**
          * @see objectPath.ensureExists
          */
-        has(path: IStringArray): boolean;
-        /**
-         * @see objectPath.has
-         */
-        has(path: INumberArray): boolean;
-        /**
-         * @see objectPath.has
-         */
-        has(path: string): boolean;
-        /**
-         * @see objectPath.has
-         */
-        has(path: number): boolean;
+        has(path: IPath): boolean;
         /**
          * @see objectPath.has
          */
@@ -315,19 +178,7 @@ declare module objectPath {
         /**
          * @see objectPath.ensureExists
          */
-        get<TResult>(path: string, defaultValue?: TResult): TResult;
-        /**
-         * @see objectPath.get
-         */
-        get<TResult>(path: IStringArray, defaultValue?: TResult): TResult;
-        /**
-         * @see objectPath.get
-         */
-        get<TResult>(path: number, defaultValue?: TResult): TResult;
-        /**
-         * @see objectPath.get
-         */
-        get<TResult>(path: INumberArray, defaultValue?: TResult): TResult;
+        get<TResult>(path: IPath, defaultValue?: TResult): TResult;
         /**
          * @see objectPath.get
          */
@@ -337,19 +188,7 @@ declare module objectPath {
         /**
          * @see objectPath.ensureExists
          */
-        set<TExisting>(path: string, value: any, doNotReplace?:boolean): TExisting;
-        /**
-         * @see objectPath.set
-         */
-        set<TExisting>(path: number, value: any, doNotReplace?:boolean): TExisting;
-        /**
-         * @see objectPath.set
-         */
-        set<TExisting>(path: IStringArray, value: any, doNotReplace?:boolean): TExisting;
-        /**
-         * @see objectPath.set
-         */
-        set<TExisting>(path: INumberArray, value: any, doNotReplace?:boolean): TExisting;
+        set<TExisting>(path: IPath, value: any, doNotReplace?:boolean): TExisting;
         /**
          * @see objectPath.set
          */
@@ -359,19 +198,7 @@ declare module objectPath {
         /**
          * @see objectPath.ensureExists
          */
-        push(path: INumberArray, ...args:any[]):void;
-        /**
-         * @see objectPath.push
-         */
-        push(path: IStringArray, ...args:any[]):void;
-        /**
-         * @see objectPath.push
-         */
-        push(path: number, ...args:any[]):void;
-        /**
-         * @see objectPath.push
-         */
-        push(path: string, ...args:any[]):void;
+        push(path: IPath, ...args:any[]):void;
         /**
          * @see objectPath.push
          */
@@ -381,37 +208,13 @@ declare module objectPath {
         /**
          * @see objectPath.ensureExists
          */
-        coalesce<TResult>(paths: IStringArray, defaultValue?: any):TResult;
-        /**
-         * @see objectPath.coalesce
-         */
-        coalesce<TResult>(paths: INumberArray, defaultValue?: any):TResult;
-        /**
-         * @see objectPath.coalesce
-         */
-        coalesce<TResult>(paths: IStringArray[], defaultValue?: any):TResult;
-        /**
-         * @see objectPath.coalesce
-         */
-        coalesce<TResult>(paths: INumberArray[], defaultValue?: any):TResult;
+        coalesce<TResult>(paths: IMultiArray, defaultValue?: TResult):TResult;
 
         /*======== Empty =========*/
         /**
          * @see objectPath.ensureExists
          */
-        empty<TResult>(path: string):TResult;
-        /**
-         * @see objectPath.empty
-         */
-        empty<TResult>(path: INumberArray):TResult;
-        /**
-         * @see objectPath.empty
-         */
-        empty<TResult>(path: IStringArray):TResult;
-        /**
-         * @see objectPath.empty
-         */
-        empty<TResult>(path: number):TResult;
+        empty(path: IPath):T;
         /**
          * @see objectPath.empty
          */
@@ -421,19 +224,7 @@ declare module objectPath {
         /**
          * @see objectPath.ensureExists
          */
-        ensureExists<TResult>(path: string, value: any):TResult;
-        /**
-         * @see objectPath.ensureExists
-         */
-        ensureExists<TResult>(path: number, value: any):TResult;
-        /**
-         * @see objectPath.ensureExists
-         */
-        ensureExists<TResult>(path: INumberArray, value: any):TResult;
-        /**
-         * @see objectPath.ensureExists
-         */
-        ensureExists<TResult>(path: IStringArray, value: any):TResult;
+        ensureExists<TExisting>(path: IPath, value: any):TExisting;
         /**
          * @see objectPath.ensureExists
          */
@@ -443,19 +234,7 @@ declare module objectPath {
         /**
          * @see objectPath.insert
          */
-        insert(path: string, value: any, at?: number):void;
-        /**
-         * @see objectPath.insert
-         */
-        insert(path: INumberArray, value: any, at?: number):void;
-        /**
-         * @see objectPath.insert
-         */
-        insert(path: IStringArray, value: any, at?: number):void;
-        /**
-         * @see objectPath.insert
-         */
-        insert(path: number, value: any, at?: number):void;
+        insert(path: IPath, value: any, at?: number):void;
     }
 }