@umoja/filterable

@umoja/filterable

simple aspect oriented programming

Filters wrap around each other and then finally around the implementation. While the first added filter is called with the input first, and last in receiving the result.

Inspired by li3 filtering system.

Features:

• small API surface 3 functions only: (applyFilter, unapplyFilter, clearFilters)
• functional
• composition based
• async filtering support (promise)
• quite simple
• small
• 1 minute learning curve
• typed (typescript)

Example

API.js

import { all as filterableAll } from '@umoja/filterable'
// or const filterableAll = require('@umoja/filterable').all

const API = filterableAll({
    create (name, id) {
        return {id, text: `${name} ${id}`}
    }
})

export { ...API }
// or  module.exports = { ...API }

Post.js

import { create as createFilterable } from '@umoja/filterable'
// or const createFilterable = require('@umoja/filterable').create
import * as API from './API'


class Post {
    public static create = createFilterable(function (filtered_id) {
        return API.create('Post', filtered_id)
    })
}

export { Post }
// or  module.exports = { Post }

index.js

import * as API from './API'
import { Post } from './Post'

API.create.applyFilter((next, name, id) => {
    console.log(`API before create: ${name} ${id}`)
    const result = next(name, id);
    console.log(`API after create: ${name} ${id}`)
    return result
});

Post.create.applyFilter((next, id) => {
    console.log(`Post before create: ${id}`)
    const result = next(id);
    console.log(`Post after create: ${id}`)
    return result
});


Post.create(1)
// log: Post before create: 1
// log: API before create: Post 1
// log: API after create: Post 1
// log: Post after create: 1
// => {id: 1, text: `Post 1`}

Changelog

8.0.0 (2021-06-06)

Performance Improvements

• create function: remove preserveContext (fb2726b)

BREAKING CHANGES

• create function: preserveContext option removed from create function

<a name="7.0.0"></a>