64 lines
2.5 KiB
Markdown
64 lines
2.5 KiB
Markdown
|
# es-object-atoms <sup>[![Version Badge][npm-version-svg]][package-url]</sup>
|
||
|
|
|
||
|
|
[![github actions][actions-image]][actions-url]
|
||
|
|
[![coverage][codecov-image]][codecov-url]
|
||
|
|
[![License][license-image]][license-url]
|
||
|
|
[![Downloads][downloads-image]][downloads-url]
|
||
|
|
|
||
|
|
[![npm badge][npm-badge-png]][package-url]
|
||
|
|
|
||
|
|
ES Object-related atoms: Object, ToObject, RequireObjectCoercible.
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
```js
|
||
|
|
const assert = require('assert');
|
||
|
|
|
||
|
|
const $Object = require('es-object-atoms');
|
||
|
|
const isObject = require('es-object-atoms/isObject');
|
||
|
|
const ToObject = require('es-object-atoms/ToObject');
|
||
|
|
const RequireObjectCoercible = require('es-object-atoms/RequireObjectCoercible');
|
||
|
|
|
||
|
|
assert.equal($Object, Object);
|
||
|
|
assert.throws(() => ToObject(null), TypeError);
|
||
|
|
assert.throws(() => ToObject(undefined), TypeError);
|
||
|
|
assert.throws(() => RequireObjectCoercible(null), TypeError);
|
||
|
|
assert.throws(() => RequireObjectCoercible(undefined), TypeError);
|
||
|
|
|
||
|
|
assert.equal(isObject(undefined), false);
|
||
|
|
assert.equal(isObject(null), false);
|
||
|
|
assert.equal(isObject({}), true);
|
||
|
|
assert.equal(isObject([]), true);
|
||
|
|
assert.equal(isObject(function () {}), true);
|
||
|
|
|
||
|
|
assert.deepEqual(RequireObjectCoercible(true), true);
|
||
|
|
assert.deepEqual(ToObject(true), Object(true));
|
||
|
|
|
||
|
|
const obj = {};
|
||
|
|
assert.equal(RequireObjectCoercible(obj), obj);
|
||
|
|
assert.equal(ToObject(obj), obj);
|
||
|
|
```
|
||
|
|
|
||
|
|
## Tests
|
||
|
|
Simply clone the repo, `npm install`, and run `npm test`
|
||
|
|
|
||
|
|
## Security
|
||
|
|
|
||
|
|
Please email [@ljharb](https://github.com/ljharb) or see https://tidelift.com/security if you have a potential security vulnerability to report.
|
||
|
|
|
||
|
|
[package-url]: https://npmjs.org/package/es-object-atoms
|
||
|
|
[npm-version-svg]: https://versionbadg.es/ljharb/es-object-atoms.svg
|
||
|
|
[deps-svg]: https://david-dm.org/ljharb/es-object-atoms.svg
|
||
|
|
[deps-url]: https://david-dm.org/ljharb/es-object-atoms
|
||
|
|
[dev-deps-svg]: https://david-dm.org/ljharb/es-object-atoms/dev-status.svg
|
||
|
|
[dev-deps-url]: https://david-dm.org/ljharb/es-object-atoms#info=devDependencies
|
||
|
|
[npm-badge-png]: https://nodei.co/npm/es-object-atoms.png?downloads=true&stars=true
|
||
|
|
[license-image]: https://img.shields.io/npm/l/es-object-atoms.svg
|
||
|
|
[license-url]: LICENSE
|
||
|
|
[downloads-image]: https://img.shields.io/npm/dm/es-object.svg
|
||
|
|
[downloads-url]: https://npm-stat.com/charts.html?package=es-object-atoms
|
||
|
|
[codecov-image]: https://codecov.io/gh/ljharb/es-object-atoms/branch/main/graphs/badge.svg
|
||
|
|
[codecov-url]: https://app.codecov.io/gh/ljharb/es-object-atoms/
|
||
|
|
[actions-image]: https://img.shields.io/endpoint?url=https://github-actions-badge-u3jn4tfpocch.runkit.sh/ljharb/es-object-atoms
|
||
|
|
[actions-url]: https://github.com/ljharb/es-object-atoms/actions
|