Skip to content

Commit

Permalink
Updating dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
DarrenPaulWright committed Oct 21, 2019
1 parent cae2343 commit 9e85cf0
Show file tree
Hide file tree
Showing 15 changed files with 616 additions and 480 deletions.
10 changes: 10 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html)

## [1.1.5] - 2019-10-21
###Security
- Updating dependencies

## [1.1.4] - 2019-10-21
###Fixed
- Don't throw an error if null or undefined are passed in to get()

## [1.1.3] - 2019-09-27
- Updating documentation

Expand Down Expand Up @@ -127,6 +135,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- [diffUpdate](docs/diffUpdate.md)
- [intersection](docs/intersection.md)

[1.1.5]: https://github.com/DarrenPaulWright/object-agent/compare/v1.1.2...1.1.5
[1.1.4]: https://github.com/DarrenPaulWright/object-agent/compare/v1.1.3...1.1.4
[1.1.3]: https://github.com/DarrenPaulWright/object-agent/compare/v1.1.2...1.1.3
[1.1.2]: https://github.com/DarrenPaulWright/object-agent/compare/v1.1.1...1.1.2
[1.1.1]: https://github.com/DarrenPaulWright/object-agent/compare/v1.1.0...1.1.1
Expand Down
7 changes: 6 additions & 1 deletion docs/clone.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,12 @@
| [settings.isCircular] | <code>Boolean</code> | <code>false</code> | If true then circular references will be handled |

**Example**
``` javascriptimport { clone } from 'object-agent';clone({ a: 'b', c: 'd' });// => { a: 'b', c: 'd' }```
``` javascript
import { clone } from 'object-agent';

clone({ a: 'b', c: 'd' });
// => { a: 'b', c: 'd' }
```

[npm]: https://img.shields.io/npm/v/object-agent.svg
[npm-url]: https://npmjs.com/package/object-agent
Expand Down
17 changes: 16 additions & 1 deletion docs/deepEqual.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,22 @@
| item2 | <code>\*</code> |

**Example**
``` javascriptimport { deepEqual } from 'object-agent';deepEqual(null, undefined);// => falseconst item1 = { a: ['b']}const item2 = { a: ['c']}deepEqual(item1, item2);// => false```
``` javascript
import { deepEqual } from 'object-agent';

deepEqual(null, undefined);
// => false

const item1 = {
a: ['b']
}
const item2 = {
a: ['c']
}

deepEqual(item1, item2);
// => false
```

[npm]: https://img.shields.io/npm/v/object-agent.svg
[npm-url]: https://npmjs.com/package/object-agent
Expand Down
19 changes: 18 additions & 1 deletion docs/diffUpdate.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,24 @@
| object2 | <code>Object</code> |

**Example**
``` javascriptimport { diffUpdate } from 'object-agent';const item1 = { a: ['b'], c: 'd', e: null}const item2 = { a: ['b'], c: null, e: null, f: 'g'}diffUpdate(item1, item2);// => { c: null, f: 'g' }```
``` javascript
import { diffUpdate } from 'object-agent';

const item1 = {
a: ['b'],
c: 'd',
e: null
}
const item2 = {
a: ['b'],
c: null,
e: null,
f: 'g'
}

diffUpdate(item1, item2);
// => { c: null, f: 'g' }
```

[npm]: https://img.shields.io/npm/v/object-agent.svg
[npm-url]: https://npmjs.com/package/object-agent
Expand Down
2 changes: 2 additions & 0 deletions docs/docs.hbs
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
{{optionSet "heading-depth" 3~}}
{{optionSet "global-index-format" "none"~}}
# {{changeCase "title" (package "name")}}

> {{package "description"}}
Expand Down
16 changes: 15 additions & 1 deletion docs/forIn.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,21 @@
| callback | <code>function</code> | Provides two args: value and key |

**Example**
``` javascriptimport { forIn } from 'object-agent';const Thing = { this.a = 'b';};Thing.prototype.c = 'd';forIn(new Thing(), (value, key) => { console.log(value, key);});// => 'b', 'a'// => 'd', 'c'```
``` javascript
import { forIn } from 'object-agent';

const Thing = {
this.a = 'b';
};

Thing.prototype.c = 'd';

forIn(new Thing(), (value, key) => {
console.log(value, key);
});
// => 'b', 'a'
// => 'd', 'c'
```

[npm]: https://img.shields.io/npm/v/object-agent.svg
[npm-url]: https://npmjs.com/package/object-agent
Expand Down
15 changes: 14 additions & 1 deletion docs/forOwn.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,20 @@
| callback | <code>function</code> | Provides two args: value and key |

**Example**
``` javascriptimport { forOwn } from 'object-agent';const thing = { a: 'b', c: 'd'};forOwn(thing, (value, key) => { console.log(value, key);});// => 'b', 'a'// => 'd', 'c'```
``` javascript
import { forOwn } from 'object-agent';

const thing = {
a: 'b',
c: 'd'
};

forOwn(thing, (value, key) => {
console.log(value, key);
});
// => 'b', 'a'
// => 'd', 'c'
```

[npm]: https://img.shields.io/npm/v/object-agent.svg
[npm-url]: https://npmjs.com/package/object-agent
Expand Down
76 changes: 38 additions & 38 deletions docs/forOwnReduce.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# Object Agent

> A javascript library for working with objects
>
> [![npm][npm]][npm-url]
[![build][build]][build-url]
[![coverage][coverage]][coverage-url]
[![deps][deps]][deps-url]
[![size][size]][size-url]
[![vulnerabilities][vulnerabilities]][vulnerabilities-url]
[![license][license]][license-url]


<br><a name="forOwnReduce"></a>

### forOwnReduce(object, callback, initialValue) ⇒ <code>\*</code>
> Iterates over own properties of an object and returns a reduced value
# Object Agent

> A javascript library for working with objects
>
> [![npm][npm]][npm-url]
[![build][build]][build-url]
[![coverage][coverage]][coverage-url]
[![deps][deps]][deps-url]
[![size][size]][size-url]
[![vulnerabilities][vulnerabilities]][vulnerabilities-url]
[![license][license]][license-url]


<br><a name="forOwnReduce"></a>

### forOwnReduce(object, callback, initialValue) ⇒ <code>\*</code>
> Iterates over own properties of an object and returns a reduced value
**Returns**: <code>\*</code> - The accumulated result


| Param | Type | Description |
| --- | --- | --- |
| object | <code>Object</code> | |
| callback | <code>function</code> | Provides three args: result, value, and key |
| initialValue | <code>\*</code> | |

| object | <code>Object</code> | |
| callback | <code>function</code> | Provides three args: result, value, and key |
| initialValue | <code>\*</code> | |

**Example**
``` javascript
import { forOwnReduce } from 'object-agent';
Expand All @@ -41,18 +41,18 @@ const output = forOwnReduce(thing, (result, value, key) => {
console.log(output);
// => [['b', 'a'], ['d', 'c']]
```

[npm]: https://img.shields.io/npm/v/object-agent.svg
[npm-url]: https://npmjs.com/package/object-agent
[build]: https://travis-ci.org/DarrenPaulWright/object-agent.svg?branch&#x3D;master
[build-url]: https://travis-ci.org/DarrenPaulWright/object-agent
[coverage]: https://coveralls.io/repos/github/DarrenPaulWright/object-agent/badge.svg?branch&#x3D;master
[coverage-url]: https://coveralls.io/github/DarrenPaulWright/object-agent?branch&#x3D;master
[deps]: https://david-dm.org/darrenpaulwright/object-agent.svg
[deps-url]: https://david-dm.org/darrenpaulwright/object-agent
[size]: https://packagephobia.now.sh/badge?p&#x3D;object-agent
[size-url]: https://packagephobia.now.sh/result?p&#x3D;object-agent
[vulnerabilities]: https://snyk.io/test/github/DarrenPaulWright/object-agent/badge.svg?targetFile&#x3D;package.json
[vulnerabilities-url]: https://snyk.io/test/github/DarrenPaulWright/object-agent?targetFile&#x3D;package.json
[license]: https://img.shields.io/github/license/DarrenPaulWright/object-agent.svg
[license-url]: https://npmjs.com/package/object-agent/LICENSE.md

[npm]: https://img.shields.io/npm/v/object-agent.svg
[npm-url]: https://npmjs.com/package/object-agent
[build]: https://travis-ci.org/DarrenPaulWright/object-agent.svg?branch&#x3D;master
[build-url]: https://travis-ci.org/DarrenPaulWright/object-agent
[coverage]: https://coveralls.io/repos/github/DarrenPaulWright/object-agent/badge.svg?branch&#x3D;master
[coverage-url]: https://coveralls.io/github/DarrenPaulWright/object-agent?branch&#x3D;master
[deps]: https://david-dm.org/darrenpaulwright/object-agent.svg
[deps-url]: https://david-dm.org/darrenpaulwright/object-agent
[size]: https://packagephobia.now.sh/badge?p&#x3D;object-agent
[size-url]: https://packagephobia.now.sh/result?p&#x3D;object-agent
[vulnerabilities]: https://snyk.io/test/github/DarrenPaulWright/object-agent/badge.svg?targetFile&#x3D;package.json
[vulnerabilities-url]: https://snyk.io/test/github/DarrenPaulWright/object-agent?targetFile&#x3D;package.json
[license]: https://img.shields.io/github/license/DarrenPaulWright/object-agent.svg
[license-url]: https://npmjs.com/package/object-agent/LICENSE.md
16 changes: 15 additions & 1 deletion docs/intersection.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,21 @@
| <code>\*</code>, <code>Array</code> |

**Example**
``` javascriptimport { intersection } from 'object-agent';intersection([1, 2, 3], [2, 3, 4], [5, 6, 2, 3]); // => [2, 3]intersection({ a: 'b', c: [1, 2, 3], d: null}, { a: 'b', c: [1, 3, 4]})// => { a: 'b', c: [1, 3] }```
``` javascript
import { intersection } from 'object-agent';

intersection([1, 2, 3], [2, 3, 4], [5, 6, 2, 3]); // => [2, 3]

intersection({
a: 'b',
c: [1, 2, 3],
d: null
}, {
a: 'b',
c: [1, 3, 4]
})
// => { a: 'b', c: [1, 3] }
```

[npm]: https://img.shields.io/npm/v/object-agent.svg
[npm-url]: https://npmjs.com/package/object-agent
Expand Down
22 changes: 21 additions & 1 deletion docs/isEmpty.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,27 @@
| item | <code>\*</code> |

**Example**
``` javascriptimport { isEmpty } from 'object-agent';isEmpty(['a', 1, 'b']);// => falseisEmpty([]);// => trueisEmpty({ a: 'b' });// => falseisEmpty({});// => trueisEmpty(null);// => trueisEmpty(undefined);// => true```
``` javascript
import { isEmpty } from 'object-agent';

isEmpty(['a', 1, 'b']);
// => false

isEmpty([]);
// => true

isEmpty({ a: 'b' });
// => false

isEmpty({});
// => true

isEmpty(null);
// => true

isEmpty(undefined);
// => true
```

[npm]: https://img.shields.io/npm/v/object-agent.svg
[npm-url]: https://npmjs.com/package/object-agent
Expand Down
13 changes: 12 additions & 1 deletion docs/isEqual.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,18 @@
| <code>\*</code>, <code>Array</code> | Can be an array of items or multiple args of items. |

**Example**
``` javascriptimport { isEqual } from 'object-agent';isEqual(null, undefined);// => falseisEqual('a', 'a', 'a');// => trueisEqual('a', 'a', 'a', null);// => false```
``` javascript
import { isEqual } from 'object-agent';

isEqual(null, undefined);
// => false

isEqual('a', 'a', 'a');
// => true

isEqual('a', 'a', 'a', null);
// => false
```

[npm]: https://img.shields.io/npm/v/object-agent.svg
[npm-url]: https://npmjs.com/package/object-agent
Expand Down
12 changes: 11 additions & 1 deletion docs/mapOwn.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,17 @@
| [ignoreKeys] | <code>Array</code>, <code>String</code> | Any keys in this array will be ignored |

**Example**
``` javascriptimport { mapOwn } from 'object-agent';const thing = { a: 'b', c: 'd'};mapOwn(thing, (value, key) => value + ' ' + key);// => { a: 'b a', c: 'd c' }```
``` javascript
import { mapOwn } from 'object-agent';

const thing = {
a: 'b',
c: 'd'
};

mapOwn(thing, (value, key) => value + ' ' + key);
// => { a: 'b a', c: 'd c' }
```

[npm]: https://img.shields.io/npm/v/object-agent.svg
[npm-url]: https://npmjs.com/package/object-agent
Expand Down
Loading

0 comments on commit 9e85cf0

Please sign in to comment.