kylefang/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/zhigang1992/DefinitelyTyped.git synced 2026-04-18 12:08:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

Add dottie (#15969)

Browse Source 
* Add dottie

* Add dottie
This commit is contained in:
Dom Armstrong
2017-05-01 15:41:29 +01:00
committed by Andy
parent 5dc27752e4
commit 6c0036b881
4 changed files with 238 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
types/dottie/dottie-tests.ts Normal file
View File

@@ -0,0 +1,21 @@
import dottie = require('dottie');
dottie.memoizePath = true;
const nestedObject = {
some: {
nested: {
value: 'a'
}
}
};
dottie.exists(nestedObject, 'some.nested');
dottie.default(nestedObject, 'some.nested.value', 'b');
dottie.get<string>(nestedObject, 'some.nested.value', 'b');
dottie.set(nestedObject, 'some.nested.value', 'b');
dottie.transform({ 'foo.bar': 'baz' });
dottie.transform({ foo_bar: 'baz' }, { delimiter: '_' });
dottie.flatten({ foo: { bar: 'baz' }});
dottie.flatten({ foo: { bar: 'baz' }}, '_');
dottie.paths(nestedObject);

194
types/dottie/index.d.ts vendored Normal file
View File

@@ -0,0 +1,194 @@
// Type definitions for dottie 2.0
// Project: https://github.com/mickhansen/dottie
// Definitions by: Dom Armstrong <https://github.com/domarmstrong/>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.2
declare const dottie: dottie.Dottie;
export = dottie;
declare namespace dottie {
type DottiePath = string | string[];
/**
* @example:
* {
* 'foo.bar.baz': 'baz',
* 'foo.baz': 'baz',
* }
*/
interface FlatPaths {
[path: string]: any;
}
interface SetOptions {
/**
* force overwrite defined non-object keys into objects if needed
*/
force?: boolean;
}
interface TransformOptions {
/**
* Use a custom delimiter for path
*/
delimiter?: string;
}
interface Dottie {
/**
* Dottie memoization flag
*/
memoizePath: boolean;
/**
* Check path exists in object
*
* @example
* const values = {
* some: {
* key: 'foobar';
* },
* }
*
* dottie.exists(values, 'some.key'); // true
* dottie.exists(values, 'some.otherKey'); // false
*/
exists(obj: object, path: DottiePath): boolean;
/**
* Gets nested value, or undefined if unreachable, or a default value if passed.
*
* @example
* const values = {
* some: {
* nested: {
* key: 'foobar';
* }
* },
* 'some.dot.included': {
* key: 'barfoo'
* }
* }
*
* dottie.get<string>(values, 'some.nested.key'); // 'foobar'
* dottie.get<string>(values, 'some.undefined.key'); // undefined
* dottie.get<string>(values, 'some.undefined.key', 'defaultval'); // 'defaultval'
* dottie.get<string>(values, ['some.dot.included', 'key']); // 'barfoo'
*/
get<T>(obj: object, path: DottiePath, defaultValue: T): T;
/**
* Sets nested value, creates nested structure if needed
*
* @example
* dottie.set(values, 'some.nested.value', someValue);
* dottie.set(values, ['some.dot.included', 'value'], someValue);
* dottie.set(values, 'some.nested.object', someValue, { force: true });
*/
set(obj: object, path: DottiePath, value: any, options?: SetOptions): void;
/**
* Set the default value if path does not exist
*
* @example
* dottie.default({}, 'some.value', 'a') as MyType; // { some: { value: 'a' }}
* dottie.default({ some: { value: 'a' }}, 'some.value', 'b') as MyType; // { some: { value: 'a' }}
*/
default(obj: object, path: DottiePath, value: any): any;
/**
* Transform object from keys with dottie notation to nested objects
*
* @example
* const values = {
* 'user.name': 'Gummy Bear',
* 'user.email': 'gummybear@candymountain.com',
* 'user.professional.title': 'King',
* 'user.professional.employer': 'Candy Mountain'
* };
* const transformed = dottie.transform(values) as MyType;
*
* assert.deepEqual(transformed, {
* user: {
* name: 'Gummy Bear',
* email: 'gummybear@candymountain.com',
* professional: {
* title: 'King',
* employer: 'Candy Mountain'
* }
* }
* });
*
* @example with custom delimiter
* const values = {
* 'user_name': 'Mick Hansen',
* 'user_email': 'maker@mhansen.io'
* };
* const transformed = dottie.transform(values, { delimiter: '_' }) as MyType;
*
* assert.deepEqual(transformed, {
* user: {
* name: 'Mick Hansen',
* email: 'maker@mhansen.io'
* }
* });
*/
transform(obj: FlatPaths, options?: TransformOptions): any;
/**
* Opposite of transform. Flattens a nested object
*
* @example
* const values = {
* user: {
* name: 'Gummy Bear',
* email: 'gummybear@candymountain.com',
* professional: {
* title: 'King',
* employer: 'Candy Mountain'
* }
* }
* };
* const transformed = dottie.transform(values);
*
* assert.deepEqual(transformed, {
* 'user.name': 'Gummy Bear',
* 'user.email': 'gummybear@candymountain.com',
* 'user.professional.title': 'King',
* 'user.professional.employer': 'Candy Mountain'
* });
*
* @example with custom delimiter
* const values = {
* user: {
* name: 'Mick Hansen',
* email: 'maker@mhansen.io'
* }
* };
* const transformed = dottie.flatten(values, '_');
*
* assert.deepEqual(transformed, {
* 'user_name': 'Mick Hansen',
* 'user_email': 'maker@mhansen.io'
* });
*/
flatten(obj: object, delimiter?: string): FlatPaths;
/**
* Get paths in object
*
* @example
* const object = {
* a: 1,
* b: {
* c: 2,
* d: { e: 3 }
* }
* };
*
* dottie.paths(object); // ["a", "b.c", "b.d.e"];
*/
paths(obj: object): string[];
}
}

22
types/dottie/tsconfig.json Normal file
View File

@@ -0,0 +1,22 @@
{
"compilerOptions": {
"module": "commonjs",
"lib": [
"es6"
],
"noImplicitAny": true,
"noImplicitThis": true,
"strictNullChecks": true,
"baseUrl": "../",
"typeRoots": [
"../"
],
"types": [],
"noEmit": true,
"forceConsistentCasingInFileNames": true
},
"files": [
"index.d.ts",
"dottie-tests.ts"
]
}

1
types/dottie/tslint.json Normal file
View File

@@ -0,0 +1 @@
{ "extends": "dtslint/dt.json" }