npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

applyfilters

v1.0.22

Published

a simple lightweight javascript module to implement hooks in your project.

Downloads

2

Readme

npm version Build Status npm NPM npm bundle size

applyfilters a JavaScript hook module

a simple lightweight javascript module to implement hooks in your project.

Execute functions hooked on a specific filter hook, specifying arguments like you know it from WordPress in your JavaScript project.

Install

npm install --save applyfilters

Usage

require

const applyfilters = require("applyfilters");

add a dofilter event

/*
 * Place the doFilter() function this will handle
 * the registred filter functions
 *
 * @param {string} filterName
 * @param filterObj
 * @param args
 *
 * @return promise
  */
applyfilters.doFilter( 'beforeSayHello', {} ).then((filteredResult) => {});

a filter function

/* 
 * Register a custom filter before doFilter('beforeSayHello') and change the response.
 * 
 * Attention: the callback function in addFilter() 
 * runs in a Promise so you have to resolve this!
 * 
 * @param {string} filterName
 * @param {function} callback
 * @param {number} priority
 * 
 * @return void 
 */
applyfilters.addFilter('beforeSayHello', (resolve, filteredResult) => {
    resolve(filteredResult);
}, 1);

applyfilters.doFilter( 'beforeSayHello', {} ).then((filteredResult) => {});

RunKit Example

const applyfilters = require("applyfilters");

// Usage see -> a filter function
applyfilters.addFilter('runKit_test', (resolve, filteredResult) => {
    filteredResult.runkit = 1;
    resolve(filteredResult);
}, 1);

// simple object
var runKitObj = {foo: "bar"}

// Usage see -> add a dofilter event
applyfilters.doFilter( 'runKit_test', runKitObj ).then((filteredResult) => {
    console.log(filteredResult);
});

Example

example/src/index.js

const applyfilters = require('applyFilters');
require('./filter')();

/** build a simple function **/
const sayHello = () => {
  const helloStr = 'John';
  const span = document.querySelector('h2 span');

  /**
   * Place the doFilter() function this will handle
   * the registered filter functions
   *
   * @param {string} filterName
   * @param filterObj
   * @param args
   *
   * @return promise
   **/
  applyfilters.doFilter( 'beforeSayHello', helloStr ).then((helloStr) => {
    span.innerHTML = helloStr;
  });
};

/* run codeexample on document loaded */
document.addEventListener('DOMContentLoaded', function(event) {
  sayHello();
});

filter the helloStr from other place like a new file example/src/filter.js

module.exports = () => {
  const applyfilters = require('applyFilters');
  
  /**
   * Register a custom filter on 'beforeSayHello' and change the response.
   *
   * Attention: the callback function in addFilter()
   * runs in a Promise so you have to resolve this!
   *
   * @param {string} filterName
   * @param {function} callback
   * @param {number} priority
   *
   * @return void
   **/
  applyfilters.addFilter('beforeSayHello', (resolve, str) => {
    str = str + ' and Rene';
    resolve(str);
  }, 1);
}

The finally result in browser

applyfilters example - say hello to Sven and Rene

What is in the inside?

| Name | Type | Description | |---|---|---| | filter | array | contains all registered filter | | addFilter | function | registers a function that use a filter/hook 'doFilter()' | | doFilter | function | register a filter/hook for this can add a filter 'addFilter()' | | asyncForEach | function | Iterate the registered filter from this.filter | | getFilter | function | returns all registered filter |

contact