Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

unpartial

Package Overview
Dependencies
Maintainers
1
Versions
26
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

unpartial

Unpartial a partialed object

  • 0.4.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
27K
decreased by-6.06%
Maintainers
1
Weekly downloads
 
Created
Source

Unpartial

unstable NPM version NPM downloads Build status Coverage Status Greenkeeper badge

Unpartial an interface.

It is very common to define a config interface and Partial<> it in a function argument. When we received the arguement, we want to merge it with our default config before using it:

import { unpartial } from 'unpartial'

interface Config {
  require: { a: number }
  optional?: { a: number }
}
const defaultConfig = { require: { a: 1 } }

function foo(givenConfig?: Partial<Config>) {
  const config = unpartial(defaultConfig, givenConfig);
  // use config with type safety
}

Code complete is avaiable as you type:

const config = unpartial(defaultConfig, { /* code completion here */});

It also supports merging two default configs. This is useful when you are extending interface from another package/class.

import { unpartial } from 'unpartial'

import { Option, defaultOption } from 'another-package'

interface MyOption extends Option { ... }

const myDefaultOption = { ... }

function foo(givenOption?: Partial<MyOption>) {
  const option = unpartial(defaultOption, myDefaultOption, givenOption)
}

Contribute

# right after fork
npm install

# begin making changes
npm run watch

Keywords

FAQs

Package last updated on 04 Nov 2017

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc