Package Exports

object-exact

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (object-exact) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

object-exact

🐤 Remove excess object members.

🥰 0 dependency.

⛲️ Out of box typescript support.

🦺 Tested.

Installation

npm i object-exact

Usage

🎵 Usage

import { objExact } from 'object-exact'

console.log(
    objExact(
        {
            a: 'use any value here except undefined',
            b: 'use any value here except undefined',
        },
        { a: 'hello', b: false, c: '!' }
    )
) // { a:"hello", b:"world" } and the type is { a:string, b:boolean }

object(dummy,target): require dummy object and target object, return new object with proper typing, does not modify original objects.

dummy: the key of this object is the key that you want, as for the value of the key, simply use any value, except undefined which bear special utility.

target: object that you want to remove excess members, this object must be subtype of dummy object, which mean must have all the keys exist in dummy object, unless the dummy key's value is undefined, it will tries to keep the key if it is available.

import { objExact } from 'object-exact'

// this will trigger typescript error: property b is missing.
// this is because `target` must bet subtype of `dummy`
console.log(objExact({ a: 1, b: 2 }, { a: 'hello' })) // { a:"hello" } and the type is { a: unknown, b: unknown }

// if you want to make a value optional
// then  let the `dummy` key's value be undefined, it will try to keep the key if it is available in `target`
console.log(objExact({ a: 1, b: undefined }, { a: 'hello', c: '!' })) // { a:"hello" } and the type is {a: string}
console.log(objExact({ a: 1, b: undefined }, { a: 'hello', b: 123, c: '!' })) // { a:"hello", b:123 } and the type is {a: string, b: number}