minibase-better-define

Plugin for base and minibase that overrides the core .define method to be more better.

Table of Contents

• Install
• Usage
• API
  • minibaseBetterDefine
  • .define
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install minibase-better-define --save

or install using yarn

$ yarn add minibase-better-define

Usage

For more use-cases see the tests

const minibaseBetterDefine = require('minibase-better-define')

API

minibaseBetterDefine

Overrides core .define method of your application. That opts option is optional and does nothing. It is just convention each plugin to export function that returns a plugin.

Params

• opts {Object}: optional, no options currently
• returns {Function}: plugin that can be pass to base/minibase's .use method

Example

var betterDefine = require('minibase-better-define')
 
var MiniBase = require('minibase').MiniBase
var app = new MiniBase()
app.use(betterDefine())
 
// or as Base plugin
 
var Base = require('base')
var base = new Base()
base.use(betterDefine())

.define

Defines a non-enumerable property to application instance if first argument key is not an object, but string. If key is object, it works like define-property lib.

It also gives you few more things: 1) if value is function it emits key event when that method is called and with arguments - that function and passed arguments to that function. 2) adds that method's name to app.registered[pluginName] where plugin name is the string passed to .isRegistered method if exists and is used.

Params

• key {String|Object}: name of the property; if object works as define-property
• value {any}: any javascript value; if function it emits event with key name
• props {Object}: works as third argument of define-property
• returns {Object}: instance of minibase for chaining, or base instance if used as Base plugin

Example

app.use(betterDefine())
 
app.define('foobar', function (a, b) {
  return a + b
})
 
app.on('foobar', function listener (fn, arg1, arg2) {
  console.log(fn) // => the `foobar` method function
  console.log(arg1) // => 111
  console.log(arg2) // => 222
})
 
console.log(app.foobar(111, 222)) // => 333
 
// or use it as normal `define-property`
var obj = {}
app.define(obj, 'foo', 123)
app.define(obj, 'qux', 'bar')
app.define(obj, 'aaa', function aaa () {})
 
console.log(obj.foo) // => 123
console.log(obj.qux) // => 'bar'
console.log(obj.aaa) // => Function: aaa

Related

• always-done: Handle completion and errors with elegance! Support for streams, callbacks, promises, child processes, async/await and sync… more | homepage
• minibase-assert: Plugin for minibase and base, that adds assertion methods - most of assert-kindof methods and built-ins… more | 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 isRegistered method to your application to detect if plugin… more | homepage
• minibase-tests: Tests for applications built on minibase or base. All Base apps passes these tests. | homepage
• minibase-visit: Plugin for minibase and base, that adds .visit method to your application to visit a method… more | homepage
• minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most… more | homepage
• mukla: Small, parallel and fast test framework with suppport for async/await, promises, callbacks, streams and observables. Targets… more | homepage
• try-catch-core: Low-level package to handle completion and errors of sync or asynchronous functions, using once and [dezalgo… more | 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 © 2016, Charlike Mike Reagent. Released under the MIT license.

---

This file was generated by verb-generate-readme, v0.2.0, on December 05, 2016.