cul

cullender

Search data and create complex filters by compose filter functions.

Showing:

Popularity

Downloads/wk

13

GitHub Stars

9

Maintenance

Last Commit

3yrs ago

Contributors

0

Package

Dependencies

2

Size (min+gzip)

1.6KB

License

MIT

Type Definitions

Built-In

Tree-Shakeable

Yes?

Categories

Readme

Cullender

Build Status

A simple and composable way to filter data.

Installation

Cullender is published on NPM registry. It's easy to integrate into your's current project environment, you have just to install like the example below and import/require cullender functions to filter something.

npm install cullender

This is a pretty module to convince you to use cullender to filter your stuff.

import { cull, filters } from 'cullender'

// ...

const latest = cull(
  [ ...users ],
  filters.truthy(),
  (user) => getTime(user.created) > getTime() - 7 * DAY
)

API

cull: (Iterable<T>, ...filters) => Array<T> - Filter data with filter functions

Example

import { cull } from 'cullender'

const isAdmin = (user) => user.role === 'admin'

cull(
  [ ...users ],
  (user) => user.isActive,
  isAdmin
)

create: ('AND'|'OR', ...filters) => boolean - Creates a filter function

Example

import { create } from 'cullender'

const isAdmin = create(
  'AND',
  (user) => user.isActive,
  (user) => user.role === 'admin'
)

[ ...users ].filter(isAdmin)

// You could also use *cull* function.
cull(users, isAdmin)

filters: Object.<string, F => filter> - Some useful filter functions

filters.truthy: <T>((T, number, Array<T>) => *) => filter - Filter truthy

Check if value, or function returned value is truthy.

Example

import { cull, filters } from 'cullender'

cull(
  users,
  filters.truthy(user => user.id)
)

filters.into: <L, T>(Iterable.<L>, (T, number, Array<T>) => *): filter - Filter into

Check if value, or function returned value is included on List.

Example

import { cull, filters } from 'cullender'

const isAuthorized = filters.into(['admin', 'manager', 'executive'], user => user.role)

const authorized = cull(users, isAuthorized)

filters.search: <T>(string, (T, number, Array<T>) => string): filter - Search terms

Check if value, or function returned value matches search terms.

Example

import { cull, filters } from 'cullender'

const terms = document.querySelector('input[type="search"]').value

const results = cull(
  users,
  (terms, user => [user.name, user.email]) // search into multiple values with
                                           // an array you can use an plan
                                           // string value either
)

filters.not: (filter) => filter - Not filter

Check if value, or function returned value matches search terms.

Example

import { cull, filters } from 'cullender'

const withoutEmailUsers = cull(
  users,
  filters.not(filters.truthy(user => user.email))
)

License

Licensed under MIT License. You can see it here.

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100