https://github.com/tylim88/object-exact
🦗Filter or partially filter object members and remove the rest, return value with accurate typing at the end, work best with typescript.
https://github.com/tylim88/object-exact
Last synced: about 2 months ago
JSON representation
🦗Filter or partially filter object members and remove the rest, return value with accurate typing at the end, work best with typescript.
- Host: GitHub
- URL: https://github.com/tylim88/object-exact
- Owner: tylim88
- License: mit
- Created: 2021-10-14T06:01:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-10-25T03:07:56.000Z (over 3 years ago)
- Last Synced: 2025-03-10T16:05:53.120Z (2 months ago)
- Language: TypeScript
- Homepage:
- Size: 206 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# object-exact
[](https://www.npmjs.com/package/object-exact) [](https://github.com/tylim88/object-exact/blob/master/LICENSE) [](https://github.com/tylim88/object-exact/pulls) [](<[LINK](https://github.com/tylim88/object-exact#object-exact)>)
🐤 Filter or partially filter object members and remove the rest, return value with accurate typing at the end, work best with typescript.
🥰 0 dependency.
⛲️ Out of box typescript support.
🦺 Tested.
## Installation
```bash
npm i object-exact
```
## 🦗 Functionality
This library allow you to filter or partially filter object members that you want to keep and discard the rest members, all without modifying the original object.
The logic in this code is simple, you can easily create one yourself, however the library assist you in creating accurate output type and handle input type with minimum interface as possible.
Example you have a object with 3 keys: `a`,`b`,`c`, where:
`a` : required, number
`b` : optional, number
`c` : discard, -
Based on this information, the library construct the target object type `{a:number, b?:number}`, and given the target objects `{a:1, b:2, c:3}` and `{a:1, c:3}`:
For optional key, it will never return partial type key, the type shape is alway the same as target object.
Hence output type of the first object is `{a:number, b:number}` and the type of the second object is `{a: number}`, both object will never return type `{a:number, b?:number}`, this allows you to process typing in more precise manner.
## 🎵 Usage
```ts
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 accurate typing, does not modify original objects.
**`dummy`**: the keys of this object is the keys that you want to keep, as for the values of the keys, **use any value, except `undefined`** which bear special utility(see explanation in `target`).
**`target`**: object that you want to remove excess members, this object must be subtype of `dummy` object(all keys exist in `dummy` object must also present in `target` object); unless the `dummy` key's value is `undefined`, then it tries to keep the key only if it is available and will not trigger typescript error if not available.
```ts
import { objExact } from 'object-exact'
// this will trigger typescript error: property b is missing.
// `target` must bet subtype of `dummy`
// NOT recommend for typescript developer, javascript developer is unaffected
console.log(objExact({ a: 1, b: 2 }, { a: 'hello' })) // { a:"hello", b: undefined } and the type is { a: unknown, b: unknown } <- wasted
// 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}
```