# assign-default-values-to-object

> A function to assign default values to undefined values in an object

Latest version **1.0.2** (published 2020-04-04) · GPL-3.0-only license · 0 weekly downloads

## Install

```sh
npm install assign-default-values-to-object
pnpm add assign-default-values-to-object
yarn add assign-default-values-to-object
bun add assign-default-values-to-object
```

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.2 |
| Published | 2020-04-04 |
| First published | 2020-02-16 |
| Weekly downloads | 0 |
| License | GPL-3.0-only |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 49.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | StraightOuttaCrompton |
| Maintainers | straight-outta-crompton |
| Keywords | assign, default, values, object |

## Links

- npm: https://www.npmjs.com/package/assign-default-values-to-object
- Repository: https://gitlab.com/StraightOuttaCrompton/assign-default-values-to-object
- Issues: https://gitlab.com/StraightOuttaCrompton/assign-default-values-to-object/issues
- npm.io page: https://npm.io/package/assign-default-values-to-object

## Recent versions

- 1.0.2 (latest) — 2020-04-04
- 1.0.1 — 2020-04-04
- 1.0.0 — 2020-02-16

## README

# Assign default values to object

An [npm module](https://www.npmjs.com/package/aws-cdk-static-site) exporting a function to assign default values to an object.

## Installing

```sh
npm i assign-default-values-to-object
```

## Basic Usage

```ts
import assignDefaultValuesToObject, { RecursiveRequired } from "assign-default-values-to-object";

interface IObject {
    requiredProp: string;
    optionalProp1?: string;
    optionalProp2?: string;
}

const object: IObject = {
    requiredProp: "objectRequiredProp",
    optionalProp1: "objectOptionalProp1"
};

const defaultObject: IObject = {
    requiredProp: "defaultObjectRequiredProp",
    optionalProp1: "defaultObjectOptionalProp1",
    optionalProp2: "defaultObjectOptionalProp2"
};

const parsedObject = assignDefaultValuesToObject(defaultObject, object) as RecursiveRequired<
    IObject
>;

console.log(parsedObject.requiredProp)
// objectRequiredProp

console.log(parsedObject.optionalProp1)
// objectOptionalProp1

console.log(parsedObject.optionalProp2)
// defaultObjectOptionalProp2
```

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md).

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