Package description
The 'base' npm package is a framework for rapidly building high-quality node.js applications, using plugins like building blocks. It's designed to be a foundation on which to build complex applications.
Plugin Management
Base allows you to easily manage and use plugins, enabling modular application development. Plugins can add specific functionalities to the base application, which can be initialized and used as needed.
const Base = require('base');
const app = new Base();
app.use(require('some-plugin'));
app.init();Event Handling
Base provides an event handling system. You can define custom events and handlers, making it easy to manage events within your application.
const Base = require('base');
const app = new Base();
app.on('event', () => console.log('Event triggered!'));
app.emit('event');Task Execution
Base supports defining and running tasks. This feature allows you to organize code into tasks that can be executed on demand, simplifying complex operations into manageable units.
const Base = require('base');
const app = new Base();
app.task('do something', () => console.log('Task done!'));
app.run('do something');Express is a web application framework for Node.js, designed for building web applications and APIs. It differs from Base in that it's specifically tailored for HTTP server functionality, whereas Base is more generalized and plugin-oriented.
Hapi is another Node.js framework for building applications and services. Hapi is similar to Base in that it supports plugins, but it is more focused on server-side applications and provides a robust configuration-led approach, compared to Base's flexible plugin system.
Readme
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.
(TOC generated by verb using markdown-toc)
Install with npm:
$ npm install base --save
var base = require('base');
inherit
function App() {
base.call(this);
}
base.extend(App);
var app = new App();
app.set('a', 'b');
app.get('a');
//=> 'b';
instantiate
var app = base();
app.set('foo', 'bar');
console.log(app.foo);
//=> 'bar'
Inherit or instantiate with a namespace
A .namespace() method is exposed on the exported function to allow you to create a custom namespace for setting/getting on the instance.
var Base = require('base')
var base = Base.namespace('cache');
var app = base();
app.set('foo', 'bar');
console.log(app.cache.foo);
//=> 'bar'
All of the methods from cache-base are exposed on the base API, as well as the following methods.
Create an instance of Base with config and options.
Params
config {Object}: passed to cache-baseoptions {Object}Example
var app = new Base({baz: 'qux'}, {yeah: 123, nope: 456});
app.set('foo', 'bar');
console.log(app.get('foo')); //=> 'bar'
console.log(app.get('baz')); //=> 'qux'
console.log(app.get('yeah')); //=> undefined
console.log(app.foo); //=> 'bar'
console.log(app.baz); //=> 'qux'
console.log(app.yeah); //=> undefined
console.log(app.options.yeah); //=> 123
console.log(app.options.nope); //=> 456
Set the given name on app._name and app.is* properties. Used for doing lookups in plugins.
Params
name {String}returns {Boolean}Example
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.Example
var base = new Base();
base.use(function(app) {
if (app.isRegistered('myPlugin')) return;
// do stuff to `app`
});
// to also record the plugin as being registered
base.use(function(app) {
if (app.isRegistered('myPlugin', true)) return;
// do stuff to `app`
});
Throws an error when plugin name is not registered.
Params
name {String}: The plugin name.Example
var base = new Base();
base.use(function(app) {
app.assertPlugin('base-foo');
app.assertPlugin('base-bar');
app.assertPlugin('base-baz');
});
Define a plugin function to be called immediately upon init. Plugins are chainable and the only parameter exposed to the plugin is the application instance.
Params
fn {Function}: plugin function to callreturns {Object}: Returns the item instance for chaining.Events
emits: use with no arguments.Example
var app = new Base()
.use(foo)
.use(bar)
.use(baz)
Lazily invoke a registered plugin. Note that this method can only be used with:
appParams
prop {String}: The name of the property or method added by the plugin.fn {Function}: The plugin functionoptions {Object}: Options to use when the plugin is invoked.returns {Object}: Returns the instance for chainingExample
app.lazy('store', require('base-store'));
Define a 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.Events
emits: define with key and value as arguments.Example
// arbitrary `render` function using lodash `template`
define('render', function(str, locals) {
return _.template(str)(locals);
});
Mix property key onto the Base prototype. If base-methods
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 instance for chaining.Getter/setter for a base (or shared) instance of base applications.
This property only works when a "parent" instance is created on app.
If app.parent is defined, the base getter ensures that the base
instance is always the very first instance.
Example
var a = new Base();
a.foo = 'bar';
var b = new Base();
b.parent = a;
var c = new Base();
c.parent = b;
console.log(c.foo);
//=> undefined
console.log(c.base.foo);
//=> 'bar'
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.Example
Base.use(function(app) {
app.foo = 'bar';
});
var app = new Base();
console.log(app.foo);
//=> 'bar'
Static method for inheriting both the prototype and
static methods of the Base class. See class-utils
for more details.
Static method for adding mixins to the prototype. When a function is returned from the mixin plugin, it will be added to an array so it can be used on inheriting classes via Base.mixins(Child).
Params
fn {Function}: Function to callExample
Base.mixin(function fn(proto) {
proto.foo = function(msg) {
return 'foo ' + msg;
};
return fn;
});
Static method for running currently saved global mixin functions against a child constructor.
Params
Child {Function}: Constructor function of a child classExample
Base.extend(Child);
Base.mixins(Child);
Similar to util.inherit, but copies all static properties,
prototype properties, and descriptors from Provider to Receiver.
class-utils for more details.
Statements : 100% ( 117/117 )
Branches : 100% ( 31/31 )
Functions : 100% ( 24/24 )
Lines : 100% ( 116/116 )
There are a number of different plugins available for extending base. Let us know if you create your own!
config method for mapping declarative configuration values to other 'base'… more | homepagedata method to base-methods. | homepagerename method that can be passed to app.dest()… more | homepagebase application. | homepageoption, enable and disable. See the readme… more | homepagepkg object with get/set methods for getting data from package.json… more | homepageproject getter to the instance for getting the name of… more | homepagePull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Generate readme and API documentation with verb:
$ npm install verb && npm run docs
Or, if verb is installed globally:
$ verb
Install dev dependencies:
$ npm install -d && npm test
Jon Schlinkert
Copyright © 2016 Jon Schlinkert Released under the MIT license.
This file was generated by verb, v0.9.0, on March 11, 2016.
FAQs
Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks
The npm package base receives a total of 8,533,882 weekly downloads. As such, base popularity was classified as popular.
We found that base demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A hospital in Mobile, Alabama, agreed to a settlement in a landmark ransomware death lawsuit, but is now reportedly reconsidering the agreement and refusing to pay.
Security News
A new report explores how advancements in LLMs are enhancing cyber threats, including polymorphic malware, personalized spearphishing, and the risk of hijacking customer service bots.
Security News
ESLint has approved an RFC that adds support for TypeScript configuration files, which is aimed at improving the developer experience and recognizing changes in the evolving JavaScript ecosystem.