Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/here-be/snapdragon-handlers
Adds support for handlers, events and plugins to snapdragon libraries.
https://github.com/here-be/snapdragon-handlers
compiler lexer nodes parser snapdragon tokens
Last synced: about 2 months ago
JSON representation
Adds support for handlers, events and plugins to snapdragon libraries.
- Host: GitHub
- URL: https://github.com/here-be/snapdragon-handlers
- Owner: here-be
- License: mit
- Created: 2018-01-08T06:32:06.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2018-01-08T06:33:59.000Z (about 7 years ago)
- Last Synced: 2024-11-14T17:51:03.547Z (about 2 months ago)
- Topics: compiler, lexer, nodes, parser, snapdragon, tokens
- Language: JavaScript
- Homepage: https://github.com/jonschlinkert
- Size: 7.81 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# snapdragon-handlers [](https://www.npmjs.com/package/snapdragon-handlers) [](https://npmjs.org/package/snapdragon-handlers) [](https://npmjs.org/package/snapdragon-handlers) [](https://travis-ci.org/here-be/snapdragon-handlers)
> Adds support for handlers, events and plugins to snapdragon libraries.
Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save snapdragon-handlers
```
## Usage
```js
const Handlers = require('snapdragon-handlers');
class MyClass extends Handlers {
// do stuff
}
```
## API
### [Handlers](index.js#L28)
Create a new `Handlers` with the given `options`.
**Params**
* `options` **{Object}**
**Example**
```js
const Handlers = require('snapdragon-handlers');
class Lexer extends Handlers {
constructor(options) {
super(options);
// do lexer stuff
}
}
```
### [.set](index.js#L51)
Register a handler function.
**Params**
* `type` **{String}**
* `fn` **{Function}**: The handler function to register.
**Example**
```js
handlers.set('star', function() {
// do parser, lexer, or compiler stuff
});
```
### [.get](index.js#L86)
Get a registered handler function.
**Params**
* `type` **{String}**
* `fn` **{Function}**: The handler function to register.
**Example**
```js
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](../../issues/new).
Please read the [contributing guide](.github/contributing.md) 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:
```sh
$ npm install && npm test
```
Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Author
**Jon Schlinkert**
* [linkedin/in/jonschlinkert](https://linkedin.com/in/jonschlinkert)
* [github/jonschlinkert](https://github.com/jonschlinkert)
* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
### License
Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on January 08, 2018._