diff --git a/dot-object/dot-object-tests.ts b/dot-object/dot-object-tests.ts index 603a66c57e..a553c6c68d 100644 --- a/dot-object/dot-object-tests.ts +++ b/dot-object/dot-object-tests.ts @@ -16,10 +16,10 @@ var src = { } }; -var tgt = {name: 'Brandon'}; +var tgt = { name: 'Brandon' }; dot.copy('stuff.phone', 'wanna.haves.phone', src, tgt, [(arg: any) => { - return arg; + return arg; }]); dot.transfer('stuff.phone', 'wanna.haves.phone', src, tgt); @@ -37,17 +37,17 @@ var row = { }; dot.object(row, (arg: any) => { - return arg; + return arg; }); dot.str('this.is.my.string', 'value', tgt); var newObj = { - some: { - nested: { - value: 'Hi there!' - } - } + some: { + nested: { + value: 'Hi there!' + } + } }; var val = dot.pick('some.nested.value', newObj); @@ -62,4 +62,9 @@ val = dot.remove('some.nested.value', newObj); // or use the alias `del` val = dot.del('some.nested.value', newObj); -var dotWithArrow = new dot('=>'); \ No newline at end of file +// convert object to dot object +var result = {}; +dot.dot({ test: 'something' }, result); +result = dot.dot({ test: 'something' }); + +var dotWithArrow = new dot('=>'); diff --git a/dot-object/index.d.ts b/dot-object/index.d.ts index 953291c631..176e1c0daf 100644 --- a/dot-object/index.d.ts +++ b/dot-object/index.d.ts @@ -1,4 +1,4 @@ -// Type definitions for Dot-Object v1.4.1 +// Type definitions for Dot-Object v1.4.2 // Project: https://github.com/rhalff/dot-object // Definitions by: Niko Kovačič // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped @@ -6,14 +6,14 @@ declare namespace DotObject { interface DotConstructor extends Dot { - new(separator: string): Dot; + new (separator: string): Dot; } interface ModifierFunctionWrapper { (arg: any): any; } - interface Dot { + interface Dot { /** * * Copy a property from one object to another object. @@ -34,11 +34,6 @@ declare namespace DotObject { * Convert object to dotted-key/value pair * * Usage: - * - * var tgt = dot.dot(obj) - * - * or - * * var tgt = {} * dot.dot(obj, tgt) * @@ -46,6 +41,18 @@ declare namespace DotObject { * @param {Object} tgt target object */ dot(obj: any, tgt: any): void + /** + * + * Convert object to dotted-key/value pair + * + * Usage: + * + * var tgt = dot.dot(obj) + * @param {Object} obj source object + * @return {Object} result + */ + dot(obj: any): any + /** * * Remove value from an object using dot notation. @@ -166,4 +173,4 @@ declare var dot: DotObject.DotConstructor; declare module 'dot-object' { export = dot; -} \ No newline at end of file +}