Installations

npm install defaults

Developer Guide

BETA

Typescript

Yes

Module System

ESM

Min. Node Version

>=18

Node Version

18.17.1

NPM Version

9.2.0 Score

99.8

Supply Chain

85.3

Quality

75.4

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

3

Closed

0

Merged

3

Issues

Open

0

Total

4

Closed

4

Releases

5

v3.0.0

Updated on Oct 18, 2023

v2.0.2

Updated on Aug 28, 2023

v2.0.1

Updated on Apr 11, 2023

v2.0.0

Updated on Apr 11, 2023

v1.0.4

Updated on Oct 10, 2022

View All 5 releases

Languages

2

JavaScript

TypeScript

JavaScript (67.62%)

TypeScript (32.38%)

Developer

sindresorhus

Download Statistics

Total Downloads

3,955,703,280

Last Day

1,295,155

Last Week

25,553,386

Last Month

110,490,113

Last Year

1,142,162,977

GitHub Statistics

MIT License

75 Stars

22 Commits

7 Forks

2 Watchers

1 Branches

4 Contributors

Updated on Jun 17, 2025

Bundle Size

759.00 B

Minified

442.00 B

Minified + Gzipped

Bundlephobia

Sponsor this package

https://github.com/sponsors/sindresorhus

Maintainers

1

View All 4 Contributors

Package Meta Information

Latest Version

3.0.0

Package Id

defaults@3.0.0

Unpacked Size

5.52 kB

Size

2.43 kB

File Count

5

NPM Version

9.2.0

Node Version

18.17.1

Published on

Oct 18, 2023

Total Downloads

Cumulative downloads

Total Downloads

3,955,703,280

Dev Dependencies

3

ava tsd xo

defaults

Easily handle defaults for your options

Install

1npm install defaults

Usage

1import defaults from 'defaults';
2
3const calculate = options => {
4	options = defaults(options, {
5		timeout: {
6			before: 100,
7			after: 100
8		}
9	});
10
11	console.log(options);
12	//=> {timeout: {before: 200, after: 100}}
13
14	// …
15}
16
17// …
18
19calculate({timeout: {before: 200}});

API

defaults(options, defaultOptions?)

Deeply merges the given options with the specified defaults and returns a new object.

The given parameters are deep-cloned and never mutated.

options

Type: object

The user-provided options.

If the value is not a plain object, a new plain object will be used instead.

defaultOptions

Type: object | undefined

The default options to use when a value is not provided in the options object.

FAQ

Why use this over object-spread?

Does not overwrite options if they are not defined in the options object
Supports deep merging of objects
Provides protection against prototype pollution attacks

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.2

/10

Last Scanned on 2025-06-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

Other packages similar to defaults

Other packages similar to defaults

defaults

Installations

Developer Guide

Yes

ESM

>=18

18.17.1

9.2.0

Score

Pull Requests

0

3

0

3

Issues

0

4

4

Releases

Languages

Developer

sindresorhus

Download Statistics

GitHub Statistics

Bundle Size

759.00 B

442.00 B

Sponsor this package

Maintainers

Package Meta Information

Total Downloads

3,955,703,280

Dev Dependencies

defaults

Install

Usage

API

defaults(options, defaultOptions?)

options

defaultOptions

FAQ

Why use this over object-spread?

10

10

10

10

10

1

0

0

0

0

0

0

0

4.2

/10

Weekly Downloads

Monthly Downloads

Yearly Downloads