Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unional/unpartial
Unpartial a partial object
https://github.com/unional/unpartial
javascript typescript utility
Last synced: 10 days ago
JSON representation
Unpartial a partial object
- Host: GitHub
- URL: https://github.com/unional/unpartial
- Owner: unional
- License: mit
- Created: 2017-10-02T07:23:12.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-10-16T15:48:50.000Z (21 days ago)
- Last Synced: 2024-10-19T09:20:28.654Z (18 days ago)
- Topics: javascript, typescript, utility
- Language: TypeScript
- Homepage:
- Size: 2.37 MB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# unpartial
[![NPM version][npm-image]][npm-url]
[![NPM downloads][downloads-image]][downloads-url]
[![GitHub NodeJS][github-nodejs]][github-action-url]
[![Codecov][codecov-image]][codecov-url]
[![Visual Studio Code][vscode-image]][vscode-url]
[![Wallaby.js][wallaby_image]][wallaby_url]
Unpartial a type.
It is very common to define a config type and `Partial<>` it in a function argument.
When we received the argument, we want to merge it with our default config before using it:
```ts
import { unpartial } from 'unpartial'
interface Config {
require: { a: number }
optional?: { a: number }
}
const defaultConfig: Config = { require: { a: 1 } }
function foo(givenConfig?: Partial) {
const config = unpartial(defaultConfig, givenConfig);
// use config with type safety
}
```
Code completion is available as you type:
```ts
const config = unpartial(defaultConfig, { /* code completion here */});
```
It also supports merging two default configs.
This is useful when you are extending the interface from another package/class.
```ts
import { unpartial } from 'unpartial'
import { Option, defaultOption } from 'another-package'
interface MyOption extends Option { ... }
const myDefaultOption = { ... }
function foo(givenOption?: Partial) {
const option = unpartial(defaultOption, myDefaultOption, givenOption)
}
```
**This is deprecated** because currently TypeScript does not support optional generic type,
so it is not possible to create a satisfactory signature that works with both implicit and explicit type.
Instead, please use composition when combining 3 or more values:
```ts
unpartial(unpartial(defaultOption, myDefaultOption), givenOption)
```
There are 3 more functions available in this library:
- `unpartialRecursively()`: `unpartial()` deeply.\
In practice, this does not seem to be useful. Maybe will be deprecated and removed in the future.
- `required()`: an alternative version of `unpartial()` with a different type management.\
This will become identical to `unpartial()` in the future.
- `requiredDeep()`: an alternative version of `unpartialRecursively()` with a different type management.\
This will become identical to `unpartial()` in the future.
`unpartial` is also exposed through [`type-plus`](https://github.com/unional/type-plus).
It contains many more functions and type utilities.
Feel free to check it out.
## Contribute
```sh
# after fork and clone
pnpm install
# begin making changes
git checkout -b
pnpm watch
# after making change(s)
git commit -m ""
git push
# create PR
```
## Wallaby.js
[![Wallaby.js][wallaby_image_lg]][wallaby_url]
This repository contributors are welcome to use
[Wallaby.js OSS License][wallaby_url] to get
test results immediately as you type, and see the results in
your editor right next to your code.
[codecov-image]: https://codecov.io/gh/unional/unpartial/branch/master/graph/badge.svg
[codecov-url]: https://codecov.io/gh/unional/unpartial
[downloads-image]: https://img.shields.io/npm/dm/unpartial.svg?style=flat
[downloads-url]: https://npmjs.org/package/unpartial
[github-nodejs]: https://github.com/unional/unpartial/workflows/release/badge.svg
[github-action-url]: https://github.com/unional/unpartial/actions
[npm-image]: https://img.shields.io/npm/v/unpartial.svg?style=flat
[npm-url]: https://npmjs.org/package/unpartial
[vscode-image]: https://img.shields.io/badge/vscode-ready-green.svg
[vscode-url]: https://code.visualstudio.com/
[wallaby_image]: https://img.shields.io/badge/wallaby.js-powered-blue.svg?style=flat&logo=github
[wallaby_image_lg]: https://img.shields.io/badge/wallaby.js-powered-blue.svg?style=for-the-badge&logo=github
[wallaby_url]: https://wallabyjs.com/oss/