base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting with a handful of common methods, like
set,get,delanduse.
Install with npm:
sh
$ npm install --save base
Base is a framework for rapidly creating high quality node.js applications, using plugins like building blocks.
The core team follows these principles to help guide API decisions:
Base or base pluginsThe API was designed to provide only the minimum necessary functionality for creating a useful application, with or without plugins.
Base core
Base itself ships with only a handful of useful methods, such as:
.set: for setting values on the instance.get: for getting values from the instance.has: to check if a property exists on the instance.define: for setting non-enumerable values on the instance.use: for adding pluginsBe generic
When deciding on method to add or remove, we try to answer these questions:
Plugin system
It couldn't be easier to extend Base with any features or custom functionality you can think of.
Base plugins are just functions that take an instance of Base:
```js var base = new Base();
function plugin(base) { // do plugin stuff, in pure JavaScript } // use the plugin base.use(plugin); ```
Inheritance
Easily inherit Base using .extend:
```js var Base = require('base');
function MyApp() { Base.call(this); } Base.extend(MyApp);
var app = new MyApp(); app.set('a', 'b'); app.get('a'); //=> 'b'; ```
Inherit or instantiate with a namespace
By default, the .get, .set and .has methods set and get values from the root of the base instance. You can customize this using the .namespace method exposed on the exported function. For example:
``js
var Base = require('base');
// get and set values on thebase.cache` object
var base = Base.namespace('cache');
var app = base(); app.set('foo', 'bar'); console.log(app.cache.foo); //=> 'bar' ```
Usage
js
var Base = require('base');
var app = new Base();
app.set('foo', 'bar');
console.log(app.foo);
//=> 'bar'
Create an instance of Base with the given config and options.
Params
config {Object}: If supplied, this object is passed to cache-base to merge onto the the instance upon instantiation.options {Object}: If supplied, this object is used to initialize the base.options object.Example
``js
// initialize withconfigandoptions`
var app = new Base({isApp: true}, {abc: true});
app.set('foo', 'bar');
// values defined with the given config object will be on the root of the instance
console.log(app.baz); //=> undefined
console.log(app.foo); //=> 'bar'
// or use .get
console.log(app.get('isApp')); //=> true
console.log(app.get('foo')); //=> 'bar'
// values defined with the given options object will be on `app.options
console.log(app.options.abc); //=> true
```
Set the given name on app._name and app.is* properties. Used for doing lookups in plugins.
Params
name {String}returns {Boolean}Example
js
app.is('foo');
console.log(app._name);
//=> 'foo'
console.log(app.isFoo);
//=> true
app.is('bar');
console.log(app.isFoo);
//=> true
console.log(app.isBar);
//=> true
console.log(app._name);
//=> 'bar'
Returns true if a plugin has already been registered on an instance.
Plugin implementors are encouraged to use this first thing in a plugin to prevent the plugin from being called more than once on the same instance.
Params
name {String}: The plugin name.register {Boolean}: If the plugin if not already registered, to record it as being registered pass true as the second argument.returns {Boolean}: Returns true if a plugin is already registered.Events
emits: plugin Emits the name of the plugin being registered. Useful for unit tests, to ensure plugins are only registered once.Example
``js
var base = new Base();
base.use(function(app) {
if (app.isRegistered('myPlugin')) return;
// do stuff toapp`
});
// to also record the plugin as being registered
base.use(function(app) {
if (app.isRegistered('myPlugin', true)) return;
// do stuff to app
});
```
Define a plugin function to be called immediately upon init. Plugins are chainable and expose the following arguments to the plugin function:
app: the current instance of Basebase: the first ancestor instance of BaseParams
fn {Function}: plugin function to callreturns {Object}: Returns the item instance for chaining.Example
js
var app = new Base()
.use(foo)
.use(bar)
.use(baz)
The .define method is used for adding non-enumerable property on the instance. Dot-notation is not supported with define.
Params
key {String}: The name of the property to define.value {any}returns {Object}: Returns the instance for chaining.Example
js
// arbitrary `render` function using lodash `template`
app.define('render', function(str, locals) {
return _.template(str)(locals);
});
Mix property key onto the Base prototype. If base is inherited using Base.extend this method will be overridden by a new mixin method that will only add properties to the prototype of the inheriting application.
Params
key {String}val {Object|Array}returns {Object}: Returns the base instance for chaining.Example
js
app.mixin('foo', function() {
// do stuff
});
Getter/setter used when creating nested instances of Base, for storing a reference to the first ancestor instance. This works by setting an instance of Base on the parent property of a "child" instance. The base property defaults to the current instance if no parent property is defined.
Example
``js
// create an instance ofBase`, this is our first ("base") instance
var first = new Base();
first.foo = 'bar'; // arbitrary property, to make it easier to see what's happening later
// create another instance
var second = new Base();
// create a reference to the first instance (first)
second.parent = first;
// create another instance
var third = new Base();
// create a reference to the previous instance (second)
// repeat this pattern every time a "child" instance is created
third.parent = second;
// we can always access the first instance using the base property
console.log(first.base.foo);
//=> 'bar'
console.log(second.base.foo);
//=> 'bar'
console.log(third.base.foo);
//=> 'bar'
// and now you know how to get to third base ;)
```
Static method for adding global plugin functions that will be added to an instance when created.
Params
fn {Function}: Plugin function to use on each instance.returns {Object}: Returns the Base constructor for chainingExample
js
Base.use(function(app) {
app.foo = 'bar';
});
var app = new Base();
console.log(app.foo);
//=> 'bar'
Static method for inheriting the prototype and static methods of the Base class. This method greatly simplifies the process of creating inheritance-based applications. See static-extend for more details.
Params
Ctor {Function}: constructor to extendmethods {Object}: Optional prototype properties to mix in.returns {Object}: Returns the Base constructor for chainingExample
```js var extend = cu.extend(Parent); Parent.extend(Child);
// optional methods Parent.extend(Child, { foo: function() {}, bar: function() {} }); ```
Used for adding methods to the Base prototype, and/or to the prototype of child instances. When a mixin function returns a function, the returned function is pushed onto the .mixins array, making it available to be used on inheriting classes whenever Base.mixins() is called (e.g. Base.mixins(Child)).
Params
fn {Function}: Function to callreturns {Object}: Returns the Base constructor for chainingExample
js
Base.mixin(function(proto) {
proto.foo = function(msg) {
return 'foo ' + msg;
};
});
Static method for running global mixin functions against a child constructor. Mixins must be registered before calling this method.
Params
Child {Function}: Constructor function of a child classreturns {Object}: Returns the Base constructor for chainingExample
js
Base.extend(Child);
Base.mixins(Child);
Similar to util.inherit, but copies all static properties, prototype properties, and getters/setters from Provider to Receiver. See class-utils for more details.
Params
Receiver {Function}: Receiving (child) constructorProvider {Function}: Providing (parent) constructorreturns {Object}: Returns the Base constructor for chainingExample
js
Base.inherit(Foo, Bar);
The following node.js applications were built with Base:
Statements : 98.91% ( 91/92 )
Branches : 92.86% ( 26/28 )
Functions : 100% ( 17/17 )
Lines : 98.9% ( 90/91 )
Breaking changes
.use and .run methods are now non-enumerableBreaking changes
.is no longer takes a function, a string must be passed.debug code has been removedapp._namespace was removed (related to debug).plugin, .use, and .define no longer emit events.assertPlugin was removed.lazy was removeddata method to base-methods. | homepagebase application. | homepageoption, enable and disable. See the readme… more | homepagepkg method that exposes pkg-store to your base application. | homepagePull requests and stars are always welcome. For bugs and feature requests, please create an issue.
| Commits | Contributor |
| --- | --- |
| 141 | jonschlinkert |
| 30 | doowb |
| 3 | charlike |
| 1 | criticalmash |
| 1 | wtgtybhertgeghgtwtg |
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
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
Jon Schlinkert
Copyright © 2017, Jon Schlinkert. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on September 07, 2017.