Adds
.option,.enableand.disablemethods to yourdushapplication
You might also be interested in dush.
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.
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).
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 🇧🇬.
(TOC generated by verb using markdown-toc)
Install with npm
$ npm install dush-options --save
or install using yarn
$ yarn add dush-options
For more use-cases see the tests
const dushOptions = require('dush-options')A plugin for dush/minibase/base that adds
.option,.enableand.disablemethods to your app. You can passoptionsto be merged withapp.options
Params
options{Object}: optional, initial options to set toapp.optionspropertyreturns{Function}: a plugin function, pass it to.usemethod of dush/minibase/base
Example
var dush = require('dush')
var options = require('dush-options')
var app = dush()
// some initial options
var opts = { foo: 'bar' }
app.use(options(opts))
console.log(app.options) // => { foo: 'bar' }
console.log(app.option()) // => { foo: 'bar' }
console.log(app.option) // => function
console.log(app.enable) // => function
console.log(app.disable) // => functionSet or get an option(s). Support dot notation syntax too. If there are no arguments it returns
app.options. Ifkeyis string and novalueargument, it gets that property from theapp.optionsobject - using get-value, soapp.option('foo.bar.qux'). Ifkeyis object it is merged withapp.optionsusing mixin-deep. If bothkeyandvalueis given then it setsvaluetokeyproperty, using set-value library.
Params
key{String|Object}: path to some option property, e.g.a.b.cvalue{any}: ifkeyis string, any value to set tokeypropertyreturns{Object}: clone of the modifiedapp.optionsobject, or somekeyvalue
Example
var app = dush()
app.use(options({ initial: 'props' }))
console.log(app.options) // => { initial: 'props' }
console.log(app.option()) // => { initial: 'props' }
app.option({ foo: 'bar' })
console.log(app.options)
// => { initial: 'props', foo: 'bar' }
app.option('qux', 123)
console.log(app.options)
// => { initial: 'props', foo: 'bar', qux: 123 }
app.option('aa.bb.cc', 'dd')
console.log(app.options)
// => {
// initial: 'props',
// foo: 'bar',
// qux: 123,
// aa: { bb: { cc: 'dd' } }
// }
console.log(app.option('aa.bb')) // => { cc: 'dd' }
console.log(app.option('aa')) // => { bb: { cc: 'dd' }
console.log(app.option('foo')) // => 'bar'Enables a
keyto havetruevalue. It is simply just a shortcut forapp.option('foo', true).
Params
key{String}: a path to property to enablereturns{Object}: always self for chaining
Example
app.use(options())
console.log(app.options) // => {}
app.enable('foo')
console.log(app.options) // => { foo: true }
app.enable('qux.baz')
console.log(app.options) // => { foo: true, qux: { baz: true } }Disable a
keyto havefalsevalue. It is simply just a shortcut forapp.option('zzz', false).
Params
key{String}: a path to property to disablereturns{Object}: always self for chaining
Example
app.use(options())
console.log(app.options) // => {}
app.enable('foo')
console.log(app.options) // => { foo: true }
app.disable('foo')
console.log(app.options) // => { foo: false }
app.enable('qux.baz')
console.log(app.options.qux) // => { baz: true }
app.disable('qux.baz')
console.log(app.options.qux) // => { baz: false }- base-options: Adds a few options methods to base-methods, like
option,enableanddisable. See the readme for the full API. | homepage - base-plugins: Upgrade's plugin support in base applications to allow plugins to be called any time after init. | homepage
- base: Framework for rapidly creating high quality node.js applications, using plugins like building blocks | homepage
- dush-no-chaining: A plugin that removes the emitter methods chaining support for
dush,base,minibaseor anything based on them | homepage - dush-promise: Plugin for
dushthat makes it a Deferred promise and adds.resolve,.reject,.thanand.catchmethods for more better… more | homepage - dush-router: A simple regex-based router for
dush,base,minibaseand 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
dushevent emitter or anything based on it | homepage - dush: Microscopic & functional event emitter in ~260 bytes, extensible through plugins. | homepage
- minibase-create-plugin: Utility for minibase and base that helps you create plugins | homepage
- minibase-is-registered: Plugin for minibase and base, that adds
isRegisteredmethod to your application to detect if plugin is already registered and… more | homepage - minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing… more | homepage
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
- Please DO NOT edit README.md, CHANGELOG.md and .verb.md files. See "Building docs" section.
- Ensure anything is okey by installing the dependencies and run the tests. See "Running tests" section.
- Always use
npm run committo commit changes instead ofgit commit, because it is interactive and user-friendly. It uses commitizen behind the scenes, which follows Conventional Changelog idealogy. - 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! :)
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.
Clone repository and run the following in that cloned directory
$ npm install && npm test
Charlike Mike Reagent
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.
![greenkeeper[bot] avatar](https://avatars.githubusercontent.com/in/505?v=4 "greenkeeper[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent