UNPKG

default-args

Version:

A simple function for providing defaults to an options argument. No dependencies, tiny amount of code.

github.com/victornpb/default-args

victornpb/default-args

67 lines (45 loc) • 2.23 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# default-args <!-- badge --> [![Version](https://img.shields.io/npm/v/default-args.svg?style=flat-square)](https://www.npmjs.com/package/default-args) [![CodeFactor](https://www.codefactor.io/repository/github/victornpb/default-args/badge?style=flat-square)](https://www.codefactor.io/repository/github/victornpb/default-args) ![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/victornpb/tiny-dedent?style=flat-square) [![bundlephobia](https://img.shields.io/bundlephobia/minzip/default-args?style=flat-square)](https://www.npmjs.com/package/default-args) [![Downloads](https://img.shields.io/npm/dt/default-args.svg?style=flat-square)](https://www.npmjs.com/package/default-args) [![Node](https://img.shields.io/node/v/default-args.svg?style=flat-square)](package.json) [![LICENSE](https://img.shields.io/github/license/victornpb/default-args?style=flat-square)](LICENSE) <!-- endbadge --> A simple function for providing defaults to an options to argument. No dependencies, tiny amount of code. ## Usage ```js import defaults from 'default-args'; function helloWorld(options) { options = defaults({ foo: true, bar: { a: 1, b: 2, }, }, options); // do something with options } ``` ## Installation ### [NPM](https://npmjs.com/package/default-args) npm install default-args ### [Yarn](https://github.com/yarnpkg/yarn) yarn add default-args ### CDN <script type="text/javascript" src="https://unpkg.com/default-args/"></script> ## Packages <!-- Output table (auto generated do not modify) --> | File | Module Type | Transpiled | Source Maps | |---------------------------|-------------|------------|-------------| | dist/default-args.esm.mjs | esm | No | No | | dist/default-args.cjs.js | cjs | Yes | Yes | | dist/default-args.esm.js | esm | Yes | Yes | | dist/default-args.js | umd | Yes | Yes | <!-- END --> ## License The code is available under the [MIT](LICENSE) license. ## Contributing We are open to contributions, see [CONTRIBUTING.md](CONTRIBUTING.md) for more info.