aboutsummaryrefslogtreecommitdiff
path: root/node_modules/dot-prop/index.d.ts
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2022-06-04 08:51:01 +0200
committerMinteck <contact@minteck.org>2022-06-04 08:51:01 +0200
commit383285ecd5292bf9a825e05904955b937de84cc9 (patch)
tree0a53b6f02c1604b078044567c03dc1b6c944c8c2 /node_modules/dot-prop/index.d.ts
downloadequestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.gz
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.tar.bz2
equestriadb-383285ecd5292bf9a825e05904955b937de84cc9.zip
Initial commit
Diffstat (limited to 'node_modules/dot-prop/index.d.ts')
-rw-r--r--node_modules/dot-prop/index.d.ts101
1 files changed, 101 insertions, 0 deletions
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<T>(
+ object: {[key: string]: any} | undefined,
+ path: string
+ ): T | undefined;
+ get<T>(
+ 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<T extends {[key: string]: any}>(
+ 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;