mesqueeb / filter-anything Goto Github PK

View Code? Open in Web Editor NEW

30.0 1.0 0.0 1.62 MB

A simple (TypeScript) integration of "pick" and "omit" to filter props of an object

Home Page: https://npmjs.com/filter-anything

License: MIT License

JavaScript 11.75% TypeScript 88.25%

filter fillables guard wildcard props-stay filter-props delete-props guarded guarded-props filter-fields

filter-anything's Introduction

Filter anything ⚔️

npm i filter-anything

An implementation that filters out object props like the TypeScript "pick" and "omit". In the Laravel world, this is also called "fillables" and "guard".

Motivation

I created this package because I needed:

be able to filter out object props based on just what we need - aka "pick" props
be able to filter out object props based on what we don't need - aka "omit" props
supports for nested properties
supports wildcards * for nested properties
the return type must be TypeScript supported! (see screenshots below)

Meet the family (more tiny utils with TS support)

Usage

Pick

With pick you pass an object and an array of keys of an object - the props which may stay.

import { pick } from 'filter-anything'

const squirtle = { id: '007', name: 'Squirtle', type: 'water' }

const newObject = pick(squirtle, ['name', 'type'])
// returns { name: 'Squirtle', type: 'water' }

Omit

With omit you pass an object and an array of keys of an object - the props which should be removed.

import { omit } from 'filter-anything'

const squirtle = { id: '007', name: 'Squirtle', type: 'water' }

const withoutId = omit(squirtle, ['id'])
// returns { name: 'Squirtle', type: 'water' }

Aliases

pick() and omit() can also be imported with the names fillable() and guard(). This pays homage to my history with Laravel. 😉

TypeScript

TypeScript users will love this, because, as you can see, the result has the correct type automatically!

Nested props

In the example below we want to get rid of the nested property called "discard".

const doc = { items: { keep: '📌', discard: '✂️' } }

pick(doc, ['items.keep'])
// returns {items: {keep: '📌'}}

omit(doc, ['items.discard'])
// returns {items: {keep: '📌'}}

Please note that TypeScript users will need to cast the result when using nested props.

Wildcards

Yes! You can also work with wildcards by using * in the path.

const doc = {
  123: { keep: '📌', discard: '✂️' },
  456: { keep: '📌', discard: '✂️' },
}
// use wildcard *
omit(doc, ['*.discard'])
// returns {
//   '123': {keep: '📌'},
//   '456': {keep: '📌'}
// }

Please note that TypeScript users will need to cast the result when using wildcards props.

Feel free to open issues for any requests, questions or bugs!

filter-anything's People

Contributors

Stargazers

Watchers

filter-anything's Issues

[Question] Why does it only work with plain object?

Why is there a check for plain object? Any class with public properties should work as well.

omit ts bug - dont correct type automatically

import { omit } from 'filter-anything'

const togglePropsa = {
  props: {
    modelValue: String,
  },
  emits: {
    'update:modelValue': (pressed: boolean) => String,
    'pressedChange': (pressed: boolean) => String,
    'click': (event: MouseEvent) => String,
  },
}
const test = omit(togglePropsa.emits, ['update:modelValue', 'pressedChange'])

ts dont omit see

dont work dynamic array

import { omit } from 'filter-anything'

const aaa = ['hasThumb', 'sizes']

const dd = omit({
      hasThumb: {
        type: Boolean,
        required: true,
      },
      sizes: {
        type: String
        required: true,
      },
    }, aaa)

Feature Request: Ability to filter out fields in an array of objects.

Ability to filter out fields in an array of objects.

    var ash = { 
        name: 'Ash Catch Em', 
        badges: [
            {name: 'Otoshi', year: 2001}
            {name: 'Mismagius', year: 2003}
            {name: 'Nando', year: 1999}
        ]
    }

    const filter = require('filter-anything');
    console.log(filter.omit(ash, ['badges.year']));
    /*
    name: 'Ash Catch Em', 
        badges: [
            {name: 'Otoshi'}
            {name: 'Mismagius'}
            {name: 'Nando'}
        ]
    }
    */

I guess syntax would have to be different, since omitting 'badges.year' would remove {badges: {year: ___} in addition to {badges: [{year: ___}, ... ] }. Maybe ['badges].year' to specify that badges is an array of objects you want to omit the field year from?

Key type safety

@mesqueeb I noticed that omit allows keys that aren't preset in the original record.

if you swap the key and record definition, it'll enforce the record's types

export declare function omit<K extends string, T extends Record<K, any>>(obj: T, keys: F.AutoPath<T, K>[]): U.Merge<O.P.Omit<T, S.Split<K, '.'>>>;
export declare const guard: typeof omit;

doesn't seem to be filtering my env

ok, I have a minimal (I think) reproduction of this, with a test https://github.com/xenoterracide/merge-anything-compilation-issue,

before you can work with this, you'll have to fix the compilation issue mentioned in mesqueeb/merge-anything#13. You can just edit the .yarnrc.yml file, and uncomment the merge-anything lines, and then run yarn && yarn test.

how to dynamic omit

import { omit } from 'filter-anything'

const obj1 = {
  a: 1,
  b: 2,
  c: 3,
}

const obj2 = {
  a: 2,
  c: 3,
  d: 4,
}
type CommonKeys = Extract<keyof typeof obj1, keyof typeof obj2> // 'a' | 'c'

const commonKeyss = Object.keys(obj1).filter(key => obj2.hasOwnProperty(key)) as CommonKeys[] // ['a', 'c']

const aa = omit(obj1, commonKeyss)
aa. // dont working dont a see only `b`