</>PackageGraphPackageGraph

defaults

npmv3.0.0TypeScript

Easily handle defaults for your options

Adopt with care

defaults is usable, with caveats. Last published 1057 days ago.

  • ?Adoption: grade ?, Not reported by this registry.

    No download data reported for this package yet.

  • DMaintenance: grade D, Poor — a real concern.

    Last published 1057 days ago.

  • AWeight: grade A, Excellent.

    Zero runtime dependencies, about 5.5 KB installed.

  • BSupply chain: grade B, Good.

    This package has a single maintainer (bus factor of 1).

  • ALicense: grade A, Excellent.

    MIT — permissive, with no copyleft found in the dependency tree.

Grades are computed deterministically from registry metadata collected by PackageGraph — downloads, dependents, publish dates, the resolved dependency tree, maintainer count, and declared licenses. No third-party scores are used.

Install cost

What you actually take on by adding defaults to a project.

0
Direct dependencies

Runtime packages this one declares itself.

0
Total installed

Distinct packages in the full runtime tree, deduplicated the way a package manager would.

5.5 KB
Install size

Unpacked size of this package plus its entire runtime tree.

—
Tree depth

Longest resolved dependency chain below this package.

Compatibility

Node.js
node >=18
Module format
ESM only
TypeScript
Types included
Install scripts
None

Quick start

A usage example from the defaults README.

jsFull README ↗
import defaults from 'defaults';

const calculate = options => {
	options = defaults(options, {
		timeout: {
			before: 100,
			after: 100
		}
	});

	console.log(options);
	//=> {timeout: {before: 200, after: 100}}

	// …
Example truncated — see the full README.

defaults vs the alternatives

Packages solving a similar problem in the npm ecosystem, compared on the signals that drive an adoption decision.

PackageWeekly downloadsDependentsLicenseLast release
defaultsthis page01MIT2 years ago
merge-descriptors113M1MIT1 day ago
rfdc46.8M3MIT1 day ago
@eslint/object-schema01Apache-2.01 day ago
define-lazy-prop01MIT1 day ago
deepmerge05MIT1 day ago

Dependencies

Declared by defaults v3.0.0. Runtime dependencies are installed with the package; dev dependencies are not.

Dev (3)

ava ^5.3.1tsd ^0.29.0xo ^0.56.0

Used by

Popular packages that depend on defaults.

wcwidthnpm

Port of C's wcwidth() and wcswidth()

↓ 0/wk◈ 1 dependents⚖ MIT

Relationship graph

Dependencies (left) and dependents (right) of defaults.

wcwidthdefaults
defaults dependencies dependents

Release history

No releases in the last two years, typically about 183 days apart.

Recent versions of defaults
VersionPublishedSizeLicense
3.0.0latest2 years ago5.5 KBMIT
2.0.23 years ago5.4 KBMIT
2.0.13 years ago5.4 KBMIT
2.0.03 years ago5.3 KBMIT
1.0.43 years ago3.8 KBMIT
1.0.311 years ago—MIT
1.0.211 years ago—MIT
1.0.111 years ago—MIT
1.0.013 years ago—MIT

Overview

defaults is an npm package that easily handle defaults for your options. It has 1 known dependents in the graph. The latest version is 3.0.0, released under the MIT license.

Who should use it

Teams working in the npm ecosystem who need easily handle defaults for your options and value a focused solution.

When not to use it

Consider an alternative if you need to or if a more actively-maintained option better fits your npm stack.

Pros

  • Ships TypeScript type definitions.
  • Clear open-source license (MIT).
  • Lean dependency tree (3 direct dependencies).

Cons

  • No significant drawbacks detected from available metadata.

Auto-generated from collected registry metadata. No external claims are inferred.

Maintainers

sindresorhus

Keywords

assignconfigdeepdefaultsmergeobjectoptionsproperties

Funding

Frequently asked questions

Should I use defaults?

defaults is usable, with caveats. Last published 1057 days ago.

How do I install defaults?

Run `npm install defaults` to add defaults to your npm project.

What license is defaults released under?

defaults is distributed under the MIT license.

How popular is defaults?

npm does not publish download counts. Within PackageGraph's crawl, 1 known packages depend on defaults.

Is defaults still maintained?

The most recent release of defaults (v3.0.0) was published 2 years ago.

Does defaults run install scripts?

No. defaults does not define preinstall, install, or postinstall scripts, so installing it does not execute publisher-supplied code.