snapdragon-handlers

snapdragon-handlers

Adds support for handlers, events and plugins to snapdragon libraries.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your :heart: and support.

Install

Install with npm:

$ npm install --save snapdragon-handlers

Usage

const Handlers = require('snapdragon-handlers');
class MyClass extends Handlers {
  // do stuff
}

API

Handlers

Create a new Handlers with the given options.

Params

• options {Object}

Example

const Handlers = require('snapdragon-handlers');
class Lexer extends Handlers {
  constructor(options) {
    super(options);
    // do lexer stuff
  }
}

.set

Register a handler function.

Params

• type {String}
• fn {Function}: The handler function to register.

Example

handlers.set('star', function() {
  // do parser, lexer, or compiler stuff
});

.get

Get a registered handler function.

Params

• type {String}
• fn {Function}: The handler function to register.

Example

handlers.set('star', function() {
  // do parser, lexer, or compiler stuff
});
const star = handlers.get('star');

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Please read the contributing guide for advice on opening issues, pull requests, and coding standards.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Author

Jon Schlinkert

• linkedin/in/jonschlinkert
• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on January 08, 2018.