Giter Club home page Giter Club logo

handle-node's Introduction

npm Dependencies devDependencies

Actions Status Actions Status

Known Vulnerabilities Total Alerts Code Quality: Javascript

License

handle-node

Simple callback delegator based on DOM Node type.

Provides an alternative to switches, numeric constant-based delegation, and DOM NodeIterators or TreeWalkers.

Installation

With ESM bundler (e.g., Rollup)

import handleNode from 'handle-node';

Node

npm install handle-node
const handleNode = require('handle-node');

Browser (any)

<script src="handle-node/dist/index-umd.js"></script>

Browser (ESM - modern browsers only)

<script type="module">
import handleNode from './node_modules/handle-node/dist/index-esm.js';

</script>

Usage

Supply a node followed by a handler object whose all optional properties (human-readable Node type names) should be set to a callback which will be passed the supplied Node and, always as the last argument, a reference to the object on which the callbacks exist. The return value will be undefined if a handler is missing, but otherwise will be the result of invoking the callback which corresponds to the supplied node's type.

Here is a demonstration reimplementing textContent (if only element and text types are known to be present):

const textContent = handleNode(node, { // This object is `textSerializer`
  element ({childNodes}, textSerializer) {
    return [...childNodes].reduce((str, node) => {
      return str + handleNode(node, textSerializer);
    }, '');
  },
  text: ({nodeValue}) => nodeValue
});

Other arguments can also be passed in after node and before the handler object, and these will also be supplied to the callbacks:

const textContent = handleNode(
  node, arg1, arg2,
  { // This object is `textSerializer`
    element ({childNodes}, arg1, arg2, textSerializer) {
      return [...childNodes].reduce((str, node) => {
        return str + handleNode(node, arg1, arg2, textSerializer);
      }, '');
    },
    text: ({nodeValue}, arg1, arg2) => nodeValue
  }
);

API

The handler object can take the following optional properties:

  • element
  • attribute
  • text
  • cdata
  • entityReference
  • entity
  • processingInstruction
  • comment
  • document
  • documentType
  • documentFragment
  • notation

handle-node's People

Contributors

brettz9 avatar dependabot[bot] avatar

Watchers

 avatar  avatar  avatar

Forkers

lgtm-migrator

handle-node's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper App’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.