tunnckoCore/dush-methods

Plugin for `dush` and anything based on it. It adds helper `.define` and `.delegate` methods

dush-methods

Plugin for dush and anything based on it. It adds helper .define and .delegate methods

You might also be interested in dush-tap-report.

Quality 👌

By using commitizen and conventional commit messages, maintaining meaningful ChangeLog and commit history based on global conventions, following StandardJS code style through ESLint and having always up-to-date dependencies through integrations like GreenKeeper and David-DM service, this package has top quality.

Stability 💯

By following Semantic Versioning through standard-version releasing tool, this package is very stable and its tests are passing both on Windows (AppVeyor) and Linux (CircleCI) with results from 100% to 400% test coverage, reported respectively by CodeCov and nyc (istanbul).

Support 👏

If you have any problems, consider opening an issue, ping me on twitter (@tunnckoCore), join the support chat room or queue a live session on CodeMentor with me. If you don't have any problems, you're using it somewhere or you just enjoy this product, then please consider donating some cash at PayPal, since this is OPEN Open Source project made with love at Sofia, Bulgaria 🇧🇬.

Table of Contents

• Install
• Usage
• API
  • methods()
  • .define
  • .delegate
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install dush-methods --save

or install using yarn

$ yarn add dush-methods

Usage

For more use-cases see the tests

const dushMethods = require('dush-methods')

API

methods()

Plugin for dush, minibase, base and anything based on them. It adds .define and .delegate methods on the app instance.

• returns {Function}: a plugin function that should be passed to .use method

Example

const dush = require('dush')
const methods = require('dush-methods')

const app = dush()
app.use(methods())

console.log(app.define) // => function
console.log(app.delegate) // => function

.define

Add non-enumerable prop with a value. It also emits a define event.

Params

• prop {String}: a name of the property
• value {any}: any type of value
• returns {Object}: instance for chaining

Example

app.define('foo', 123)
console.log(app.foo) // => 123

app.on('define', (key, value) => {
  console.log('key:', key) // => 'key: foo'
  console.log('value:', value) // => 'value: 123'
})

// or inside plugin
app.use((app) => {
  app.define('hello', (place) => console.log(`Hello ${place}!`))
})

app.hello('world') // => 'Hello world!'

.delegate

Calls the .define method for each property on props object. It also emits delegate event.

Params

• props {Object}: an object of properties
• returns {Object}: instance for chaining

Example

// called two times
app.on('define', (key, value) => {
  console.log(key) // => `foo`, then `qux`
  console.log(value) // => `bar`, then `123`
})

// called one time
app.on('delegate', (props) => {
  console.log('props:', props) // => { foo: 'bar', qux: 123 }
})

app.delegate({
  foo: 'bar',
  qux: 123
})

Related

• dush-methods: Plugin for dush and anything based on it. It adds helper .define and .delegate methods | homepage
• dush-no-chaining: A plugin that removes the emitter methods chaining support for dush, base, minibase or anything based on them | homepage
• dush-options: Adds .option, .enable and .disable methods to your dush application | homepage
• dush-promise: Plugin for dush that makes it a Deferred promise and adds .resolve, .reject, .than and .catch methods for more better… more | homepage
• dush-router: A simple regex-based router for dush, base, minibase and anything based on them. Works on Browser and Node.js | homepage
• dush-tap-report: A simple TAP report producer based on event system. A plugin for dush event emitter or anything based on it | homepage
• dush: Microscopic & functional event emitter in ~260 bytes, extensible through plugins. | homepage
• gibon: Functional client-side router in ~570 bytes, built on HTML5 History API | homepage
• gruu-api: Core API for Gruu and Mukla - Minimal, modern and extensible test runners | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guidelines for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to contact me at CodeMentor.io too.

In short: If you want to contribute to that project, please follow these things

1. Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
2. Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
3. Always use npm run commit to commit changes instead of git commit, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy.
4. Do NOT bump the version in package.json. For that we use npm run release, which is standard-version and follows Conventional Changelog idealogy.

Thanks a lot! :)

Building docs

Documentation and that readme is generated using verb-generate-readme, which is a verb generator, so you need to install both of them and then run verb command like that

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

Please don't edit the README directly. Any changes to the readme must be made in .verb.md.

Running tests

Clone repository and run the following in that cloned directory

$ npm install && npm test

Author

Charlike Mike Reagent

• github/tunnckoCore
• twitter/tunnckoCore
• codementor/tunnckoCore

License

Copyright © 2017, Charlike Mike Reagent. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.4.3, on April 02, 2017.
Project scaffolded using charlike cli.