# xok

> Extend an object with the "has own property"'s of other object(s)

Latest version **2.0.0** (published 2016-06-30) · WTFPL license · 0 weekly downloads

## Install

```sh
npm install xok
pnpm add xok
yarn add xok
bun add xok
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2016-06-30 |
| First published | 2014-06-09 |
| Weekly downloads | 0 |
| License | WTFPL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Nathan Vander Wilt |
| Maintainers | natevw |

## Links

- npm: https://www.npmjs.com/package/xok
- Repository: https://github.com/natevw/xok
- Issues: https://github.com/natevw/xok/issues
- npm.io page: https://npm.io/package/xok

## Recent versions

- 2.0.0 (latest) — 2016-06-30
- 1.0.0 — 2014-06-09

## README

# xok

---

**NOTE**: as it turns out, this library very closely matched the behavior of the new `Object.assign` builtin! ([MDN documentation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/assign))

To celebrate, I've updated it to simply use the builtin implementation when available. So you can use this as a quasi-polyfill for `Object.assign` if you'd like, or just use `Object.assign`

Main differences:

- `xok` doesn't check or convert its `target` to an object like `Object.assign` does
- `xok` has a slightly different check for the validity of subsequent arguments

---

Simply extend an object with the keys from others.

The name is short for extend-object-ownkeys; hat tip to [@henrikjoreteg](https://twitter.com/henrikjoreteg) for ['extend-object'](https://www.npmjs.org/package/extend-object) which does pretty much the same thing as this, but uses `for … in` to match Underscore.js instead of `Object.keys` to match ???. See also ['extend'](https://www.npmjs.org/package/extend) if you want all the $.extend features.


## Example

```js
var extend = require('xok'),
    assert = function (ok) { if (!ok) throw Error(); };

// use for shallow copies
var sampleObj = {abc:123,def:42},
    shallowClone = extend({}, sampleObj);
assert('abc' in shallowClone);
shallowClone.def = 0;
assert(sampleObj.def === 42);

// or defaulting options!
function test(opts) {
    opts = extend({
        foo: true,
        bar: 'someDefault'
    }, opts);
    
    return (opts.foo) ? opts.bar : null;
}
assert(test() === 'someDefault');
assert(test({bar:'customValue'}) === 'customValue');
assert(test({foo:false}) === null);
```


## API

* `extend = require('xok')` — this module exports a single function.
* `extend(target, …)` — returns `target` after going through all the following arguments and shallow-copying the objects' own properties into it. The extra arguments may be `null` (anything `false`y really) but are otherwise expected to be objects and not strings or cheeses or wild animals or whatever.


## License

Solipsistic Public License; see LICENSE file for details.

---
_Source: https://npm.io/package/xok · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._