From 383285ecd5292bf9a825e05904955b937de84cc9 Mon Sep 17 00:00:00 2001 From: Minteck Date: Sat, 4 Jun 2022 08:51:01 +0200 Subject: Initial commit --- node_modules/dot-prop/index.d.ts | 101 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 101 insertions(+) create mode 100644 node_modules/dot-prop/index.d.ts (limited to 'node_modules/dot-prop/index.d.ts') diff --git a/node_modules/dot-prop/index.d.ts b/node_modules/dot-prop/index.d.ts new file mode 100644 index 0000000..861f533 --- /dev/null +++ b/node_modules/dot-prop/index.d.ts @@ -0,0 +1,101 @@ +declare const dotProp: { + /** + @param object - Object to get the `path` value. + @param path - Path of the property in the object, using `.` to separate each nested key. Use `\\.` if you have a `.` in the key. + @param defaultValue - Default value. + + @example + ``` + import dotProp = require('dot-prop'); + + dotProp.get({foo: {bar: 'unicorn'}}, 'foo.bar'); + //=> 'unicorn' + + dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep'); + //=> undefined + + dotProp.get({foo: {bar: 'a'}}, 'foo.notDefined.deep', 'default value'); + //=> 'default value' + + dotProp.get({foo: {'dot.dot': 'unicorn'}}, 'foo.dot\\.dot'); + //=> 'unicorn' + ``` + */ + get( + object: {[key: string]: any} | undefined, + path: string + ): T | undefined; + get( + object: {[key: string]: any} | undefined, + path: string, + defaultValue: T + ): T; + + /** + @param object - Object to set the `path` value. + @param path - Path of the property in the object, using `.` to separate each nested key. Use `\\.` if you have a `.` in the key. + @param value - Value to set at `path`. + @returns The object. + + @example + ``` + import dotProp = require('dot-prop'); + + const object = {foo: {bar: 'a'}}; + dotProp.set(object, 'foo.bar', 'b'); + console.log(object); + //=> {foo: {bar: 'b'}} + + const foo = dotProp.set({}, 'foo.bar', 'c'); + console.log(foo); + //=> {foo: {bar: 'c'}} + + dotProp.set(object, 'foo.baz', 'x'); + console.log(object); + //=> {foo: {bar: 'b', baz: 'x'}} + ``` + */ + set( + object: T, + path: string, + value: unknown + ): T; + + /** + @param object - Object to test the `path` value. + @param path - Path of the property in the object, using `.` to separate each nested key. Use `\\.` if you have a `.` in the key. + + @example + ``` + import dotProp = require('dot-prop'); + + dotProp.has({foo: {bar: 'unicorn'}}, 'foo.bar'); + //=> true + ``` + */ + has(object: {[key: string]: any} | undefined, path: string): boolean; + + /** + @param object - Object to delete the `path` value. + @param path - Path of the property in the object, using `.` to separate each nested key. Use `\\.` if you have a `.` in the key. + @returns A boolean of whether the property existed before being deleted. + + @example + ``` + import dotProp = require('dot-prop'); + + const object = {foo: {bar: 'a'}}; + dotProp.delete(object, 'foo.bar'); + console.log(object); + //=> {foo: {}} + + object.foo.bar = {x: 'y', y: 'x'}; + dotProp.delete(object, 'foo.bar.x'); + console.log(object); + //=> {foo: {bar: {y: 'x'}}} + ``` + */ + delete(object: {[key: string]: any}, path: string): boolean; +}; + +export = dotProp; -- cgit