A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://www.npmjs.com/package/base-methods below:

base-methods - npm

base-methods

base-methods is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting with a handful of common methods, like set, get, del and use.

(TOC generated by verb)

Install

Install with npm

$ npm i base-methods --save

Usage

var base = require('base-methods');

inherit

function App() {

  base.call(this);

}

base.extend(App);

 

var app = new App();

app.set('a', 'b');

app.get('a');

instantiate

var app = base();

app.set('foo', 'bar');

console.log(app.foo);

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-methods')

var base = Base.namespace('cache');

 

var app = base();

app.set('foo', 'bar');

console.log(app.cache.foo);

API Base

Create an instance of Base with options.

Params

Example

var app = new Base();

app.set('foo', 'bar');

console.log(app.get('foo'));

.use

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

Example

var app = new Base()

  .use(foo)

  .use(bar)

  .use(baz)

.set

Assign value to key. Also emits set with the key and value.

Params

Example

app.on('set', function(key, val) {

  

});

 

app.set(key, value);

 

app.set({name: 'Halle'});

app.set([{foo: 'bar'}, {baz: 'quux'}]);

console.log(app);

.get

Return the stored value of key. Dot notation may be used to get [nested property values][get-value].

Params

Example

app.set('a.b.c', 'd');

app.get('a.b');

 

app.get(['a', 'b']);

.has

Return true if app has a stored value for key, false only if typeof value is undefined.

Params

Example

app.set('foo', 'bar');

app.has('foo');

.del

Delete key from the instance. Also emits del with the key of the deleted item.

Params

Example

app.del(); 

app.del('foo');

app.del(['foo', 'bar']);

.define

Define a non-enumerable property on the instance.

Params

Example

define('render', function(str, locals) {

  return _.template(str)(locals);

});

.visit

Visit method over the items in the given object, or map visit over the objects in an array.

Params

.mixin

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

.use

Static method for adding global plugin functions that will be added to an instance when created.

Params

Example

Base.use(function(app) {

  app.foo = 'bar';

});

var app = new Base();

console.log(app.foo);

.extend

Static method for inheriting both the prototype and static methods of the Base class. See [class-utils][] for more details.

.Base.mixin

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

Example

Base.mixin(function fn(proto) {

  proto.foo = function(msg) {

    return 'foo ' + msg;

  };

  return fn;

});

.Base.mixins

Static method for running currently saved global mixin functions against a child constructor.

Params

Example

Base.extend(Child);

Base.mixins(Child);

.inherit

Similar to util.inherit, but copies all static properties, prototype properties, and descriptors from Provider to Receiver. [class-utils][] for more details.

Related projects

There are a number of different plugins available for extending base-methods. Let us know if you create your own!

Running tests

Install dev dependencies:

$ npm i -d && npm test

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Author

Jon Schlinkert

License

Copyright © 2015 Jon Schlinkert Released under the MIT license.

This file was generated by verb on December 20, 2015.


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4