minibase-visit

Plugin for minibase and base, that adds .visit method to your application to visit a method over the items in an object, or map visit over the objects in an array. Using using collection-visit package.

Table of Contents

• Install
• Usage
• API
  • minibaseVisit
  • .visit
• Related
• Contributing
• Building docs
• Running tests
• Author
• License

(TOC generated by verb using markdown-toc)

Install

Install with npm

$ npm install minibase-visit --save

or install using yarn

$ yarn add minibase-visit

Usage

For more use-cases see the tests

const minibaseVisit = require('minibase-visit')

API

minibaseVisit

Adds .visit method to 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 visit = require('minibase-visit')

var MiniBase = require('minibase').MiniBase
var app = new MiniBase()
app.use(visit())

// or as Base plugin

var Base = require('base')
var base = new Base()
base.use(visit())

.visit

Visit method over the properties in the base/minibase instance or map visit over the object-elements in an array. More info can see on collection-visit to understand how this works.

Params

• method {String}: method to be called on each item in value, recursively
• value {Array|Object}: object/array to be visited
• returns {Object}: MiniBase/Base instance for chaining

Example

var visit = require('minibase-visit')
var app = require('minibase')

app.use(visit())

var context = {}

app.foobar = function foobar (key, value) {
  context[key] = value
}

app.visit('foobar', {
  aa: 123,
  cc: {
    dd: 'bbb'
  }
})

console.log(context.aa) // => 123
console.log(context.cc) // => { dd: 'bbb' }
console.log(context.dd) // => 'bbb'

Related

• base-task-alias: Plugin that adds .taskAlias method to your @node-base application. Creating alias task for some task. | homepage
• minibase-assert: Plugin for minibase and base, that adds assertion methods - most of assert-kindof methods and built-ins assert module. | homepage
• minibase-better-define: Plugin for base and minibase that overrides the core .define method to be more better. | 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 is already registered and returns true or false if… more | homepage
• minibase-results: Plugin for minibase that adds useful initial properties for test results | homepage
• minibase-tests: Tests for applications built on minibase or base. All Base apps passes these tests. | homepage
• minibase: Minimalist alternative for Base. Build complex APIs with small units called plugins. Works well with most of the already existing base plugins. | homepage
• try-catch-core: Low-level package to handle completion and errors of sync or asynchronous functions, using once and dezalgo libs. Useful for and used in higher-level libs such… 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.

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

License

Copyright © 2016, Charlike Mike Reagent. Released under the MIT license.

This file was generated by verb-generate-readme, v0.2.0, on November 17, 2016.