X-Git-Url: https://git.josue.xyz/?a=blobdiff_plain;f=.config%2Fcoc%2Fextensions%2Fnode_modules%2Fcoc-prettier%2Fnode_modules%2Fdot-prop%2Findex.d.ts;fp=.config%2Fcoc%2Fextensions%2Fnode_modules%2Fcoc-prettier%2Fnode_modules%2Fdot-prop%2Findex.d.ts;h=21b05459537649cafdf558697805fdeedc156fa8;hb=3aba54c891969552833dbc350b3139e944e17a97;hp=0000000000000000000000000000000000000000;hpb=1def8ecce8e6f3aa32e6978d0ba7846a99b8de34;p=dotfiles%2F.git diff --git a/.config/coc/extensions/node_modules/coc-prettier/node_modules/dot-prop/index.d.ts b/.config/coc/extensions/node_modules/coc-prettier/node_modules/dot-prop/index.d.ts new file mode 100644 index 00000000..21b05459 --- /dev/null +++ b/.config/coc/extensions/node_modules/coc-prettier/node_modules/dot-prop/index.d.ts @@ -0,0 +1,99 @@ +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`. + + @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. + + @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): void; +}; + +export = dotProp;