hammy2899 / o

common object helper functions

o

common object helper functions written in TypeScript which can be used in NodeJS and the browser (supports ES6).

Installation

NPM

$ npm install o

Yarn

$ yarn add o

Usage

TypeScript

import o from 'o';
// or require specific functions
import { is, empty } from 'o';

NodeJS

const o = require('o');
// or require specific functions
const { is, empty } = require('o');

Browser

ES6

<!-- Script tag -->
<script
  type="module"
  src="./o.min.js"
/>

<!-- Import syntax -->
<script type="text/javascript">
  import './o.min.js';
</script>

CDN/Script

<script
  type="application/javascript"
  src="https://cdn.jsdelivr.net/npm/[email protected]/dist/o.min.js"
/>

Example usage

const a = {
  a: 1,
  b: 2,
  c: {
    d: 3,
    e: 4,
  },
};

is(a); // => true
empty(a); // => false
has(a, 'a'); // => true
has(a, 'd'); // => false
has(a, 'c.d'); // => true

const b = set(a, 'f', 5);
get(b, 'f'); // => 5

For more examples and a list of all functions view the documentation page.

Documentation

You can view the documentation here, docs are generated by TypeDoc.

Contributing

All functions are documented with TypeDoc and are fully commented explaining how they works. If you want to contribute feel free to open a PR. When you open a PR please make sure yarn test and yarn lint both pass with no errors and if any tests fail or any linting issues are raised please fix them accordingly.

o's Issues

array index support in dot notation

Add support for array indexes in dot notation

const a = {
  a: [
    {
      a: 'inside array',
    },
  ],
};

get(a, 'a[0].a'); // => "inside array"

Dependabot couldn't find the branch develop

Dependabot was set up to create pull requests against the branch develop, but couldn't find it.

If the branch has been permanently deleted you can update Dependabot's target branch from your dashboard.

You can mention @dependabot in the comments below to contact the Dependabot team.

diff function

Add diff function

Diff 2 objects

const a = {
  a: 1,
  b: 2,
  c: 3
};

const b = {
  a: 2,
  c: 3,
  d: 4
};

diff(a, b);
// {
//   "removal": {
//     "total": 1,
//     "keys": [
//       "b"
//     ]
//   },
//   "addition": {
//     "total": 1,
//     "keys": [
//       "d"
//     ]
//   },
//   "changes": {
//     "total": 1,
//     "keys": [
//       "a"
//     ]
//   },
//   "original": {
//     "a": 1,
//     "b": 2,
//     "c": 3
//   },
//   "changed": {
//     "a": 2,
//     "c": 3,
//     "d": 4
//   }
// }

Dependabot couldn't find the branch develop

Dependabot was set up to create pull requests against the branch develop, but couldn't find it.

If the branch has been permanently deleted you can update Dependabot's target branch from your dashboard.

You can mention @dependabot in the comments below to contact the Dependabot team.

convert function

Add convert function

Converts specified keys into something else

const a = {
  testa: 1,
  b: 2,
  c: 3,
};

convert(a, 'testa', 'a'); // => { a: 1, b: 2, c: 3 }

const a = {
  testa: 1,
  testb: 2,
  c: 3,
};

convert(a, [
  'testa',
  'testb',
], [
  'a',
  'b',
]); // => { a: 1, b: 2, c: 3 }

equal & deepEqual functions

Two functions to check if two or more objects are exactly the same.

1. equal(object, ...compare)
2. deepEqual(object, ...compare) (will check inner objects)

has undefined error

.has() throws an error when checking an object which doesn't have a property

Standard Version

Add standard-version for a changelog

Add module to package.json

Add "module": "src/index.js", to package.json for webpack, rollup etc support