Skip to content

Commit

Permalink
chore(release): update dist
Browse files Browse the repository at this point in the history
  • Loading branch information
Sean Hamilton committed Aug 28, 2019
1 parent 8dc4eb2 commit a3c211e
Show file tree
Hide file tree
Showing 35 changed files with 2,531 additions and 2,542 deletions.
38 changes: 19 additions & 19 deletions dist/clean.d.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
import { CleanOptions, OObject } from './types';
export declare const DefaultOptions: CleanOptions;
/**
* Remove `null` and `undefined` values from the specified object
*
* @example
* ```
* const a = { a: 1, b: null, c: undefined };
*
* clean(a); // => { a: 1 }
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function clean(obj: OObject, options?: CleanOptions): OObject;
export default clean;
import { CleanOptions, OObject } from './types';
export declare const DefaultOptions: CleanOptions;
/**
* Remove `null` and `undefined` values from the specified object
*
* @example
* ```
* const a = { a: 1, b: null, c: undefined };
*
* clean(a); // => { a: 1 }
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function clean(obj: OObject, options?: CleanOptions): OObject;
export default clean;
44 changes: 22 additions & 22 deletions dist/clone.d.ts
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
import { OObject } from './types';
/**
* Clone the specified object.
* Modifying the properties of a cloned object won't affect the original.
*
* @example
* ```
* const a = { a: 1 };
*
* const b = clone(a);
* b.a = 2;
*
* console.log(a.a, b.a); // => 1 2
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function clone(obj: OObject): OObject;
export default clone;
import { OObject } from './types';
/**
* Clone the specified object.
* Modifying the properties of a cloned object won't affect the original.
*
* @example
* ```
* const a = { a: 1 };
*
* const b = clone(a);
* b.a = 2;
*
* console.log(a.a, b.a); // => 1 2
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function clone(obj: OObject): OObject;
export default clone;
50 changes: 25 additions & 25 deletions dist/deepEqual.d.ts
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
import { OObject } from './types';
/**
* Check whether all objects deeply equal each other
*
* @example
* ```
* const a = { a: 1, b: { c: 2 } };
* const b = { a: 1, b: { c: 2 } };
* const c = { a: 1 };
* const d = { a: 2 };
* const e = { a: 1, b: { c: 2 } };
* const f = { a: 1, b: { c: 3 } };
*
* deepEqual(a, b); // => true
* deepEqual(c, d); // => false
* deepEqual(e, f); // => false
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function deepEqual(obj: OObject, ...compareWith: OObject[]): boolean;
export default deepEqual;
import { OObject } from './types';
/**
* Check whether all objects deeply equal each other
*
* @example
* ```
* const a = { a: 1, b: { c: 2 } };
* const b = { a: 1, b: { c: 2 } };
* const c = { a: 1 };
* const d = { a: 2 };
* const e = { a: 1, b: { c: 2 } };
* const f = { a: 1, b: { c: 3 } };
*
* deepEqual(a, b); // => true
* deepEqual(c, d); // => false
* deepEqual(e, f); // => false
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function deepEqual(obj: OObject, ...compareWith: OObject[]): boolean;
export default deepEqual;
38 changes: 19 additions & 19 deletions dist/deflate.d.ts
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
import { OObject } from './types';
/**
* Deflate the specified object into a one deep object
* (keys will be dot notation)
*
* @example
* ```
* const a = { a: 1, b: { c: 2 } };
*
* deflate(a); // => { a: 1, 'b.c': 2 }
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function deflate(obj: OObject): OObject;
export default deflate;
import { OObject } from './types';
/**
* Deflate the specified object into a one deep object
* (keys will be dot notation)
*
* @example
* ```
* const a = { a: 1, b: { c: 2 } };
*
* deflate(a); // => { a: 1, 'b.c': 2 }
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function deflate(obj: OObject): OObject;
export default deflate;
36 changes: 18 additions & 18 deletions dist/del.d.ts
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
import { OObject } from './types';
/**
* Delete the specified path from the object
*
* @example
* ```
* const a = { a: 1, b: { c: 2 } };
*
* del(a, 'b.c'); // => { a: 1, b: {} }
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function del(obj: OObject, path: string): OObject;
export default del;
import { OObject } from './types';
/**
* Delete the specified path from the object
*
* @example
* ```
* const a = { a: 1, b: { c: 2 } };
*
* del(a, 'b.c'); // => { a: 1, b: {} }
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function del(obj: OObject, path: string): OObject;
export default del;
62 changes: 31 additions & 31 deletions dist/each.d.ts
Original file line number Diff line number Diff line change
@@ -1,31 +1,31 @@
import { EachOptions, OObject, EachCallback } from './types';
export declare const DefaultOptions: EachOptions;
/**
* Foreach over an objects keys
*
* @example
* ```
* const a = { a: 1, b: { c: 2 } };
*
* each(a, (key, value) => {
* console.log(key, value);
* // => a 1
* // => b { c: 2 }
* });
*
* each(a, (key, value) => {
* console.log(key, value);
* // => a 1
* // => b.c 2
* }, {
* follow: true,
* });
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function each(obj: OObject, cb: EachCallback, options?: EachOptions): void;
export default each;
import { EachOptions, OObject, EachCallback } from './types';
export declare const DefaultOptions: EachOptions;
/**
* Foreach over an objects keys
*
* @example
* ```
* const a = { a: 1, b: { c: 2 } };
*
* each(a, (key, value) => {
* console.log(key, value);
* // => a 1
* // => b { c: 2 }
* });
*
* each(a, (key, value) => {
* console.log(key, value);
* // => a 1
* // => b.c 2
* }, {
* follow: true,
* });
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function each(obj: OObject, cb: EachCallback, options?: EachOptions): void;
export default each;
40 changes: 20 additions & 20 deletions dist/empty.d.ts
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
import { OObject } from './types';
/**
* Check if the specified object is empty.
*
* @example
* ```
* const a = { a: 1, b: 2 };
* const b = {};
*
* empty(a); // => false
* empty(b); // => true
* ```
*
* @throws Error
*
* @since 1.0.0
* @version 2.0.0
*/
declare function empty(obj: OObject): boolean;
export default empty;
import { OObject } from './types';
/**
* Check if the specified object is empty.
*
* @example
* ```
* const a = { a: 1, b: 2 };
* const b = {};
*
* empty(a); // => false
* empty(b); // => true
* ```
*
* @throws Error
*
* @since 1.0.0
* @version 2.0.0
*/
declare function empty(obj: OObject): boolean;
export default empty;
52 changes: 26 additions & 26 deletions dist/equal.d.ts
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
import { OObject } from './types';
/**
* Check whether all the objects are equal
* (only 1 layer deep, use equalDeep for a deep comparison)
*
* @example
* ```
* const a = { a: 1, b: { c: 2 } };
* const b = { a: 1, b: { c: 2 } };
* const c = { a: 1 };
* const d = { a: 2 };
* const e = { a: 1, b: { c: 2 } };
* const f = { a: 1, b: { c: 3 } };
*
* equal(a, b); // => true
* equal(c, d); // => false
* equal(e, f); // => true
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function equal(obj: OObject, ...compareWith: OObject[]): boolean;
export default equal;
import { OObject } from './types';
/**
* Check whether all the objects are equal
* (only 1 layer deep, use equalDeep for a deep comparison)
*
* @example
* ```
* const a = { a: 1, b: { c: 2 } };
* const b = { a: 1, b: { c: 2 } };
* const c = { a: 1 };
* const d = { a: 2 };
* const e = { a: 1, b: { c: 2 } };
* const f = { a: 1, b: { c: 3 } };
*
* equal(a, b); // => true
* equal(c, d); // => false
* equal(e, f); // => true
* ```
*
* @throws TypeError
*
* @since 1.0.0
* @version 2.0.0
*/
declare function equal(obj: OObject, ...compareWith: OObject[]): boolean;
export default equal;
Loading

0 comments on commit a3c211e

Please sign in to comment.