npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

cocktail-trait-configurable

v1.1.0

Published

Provides configurable method to set properties on host class by a given object

Downloads

17

Readme

cocktail-trait-configurable

A CocktailJS Trait Extension

Build Status NPM version

A trait to add configure(options) method that will call setters on each options key.

Install

npm install cocktail --save
npm install cocktail-trait-configurable --save

Trait requires (glue code)

None

Usage

MyClass.js


var cocktail     = require('cocktail'),
	Configurable = require('cocktail-trait-configurable');
	
cocktail.mix({
    '@exports': module,
    '@as'     : 'class',

    '@traits' : [Configurable],
    
    '@properties': {
    	property1: 'default value',
    	property2: 0
    },

    constructor: function(config) {
        //we can use configurable method in the constructor
        this.configure(config);
    }
    
});

index.js


var MyClass = require('./MyClass'),
    options, obj, obj2;

options = {
    property1: 'value from options', 
    property2: false, 
    discarded: 'this should be discarded!'
});

obj = new MyClass();

//use the configure method publicly
obj.configure(options);

console.log(obj.getProperty1()); //'value from options'
console.log(obj.getProperty2()); //false

//or in the constructor
obj2 = new MyClass(options);

console.log(obj2.getProperty1()); //'value from options'
console.log(obj2.getProperty2()); //false

Configuring the Configurable Trait

Since version 1.1.0 we can use Configurable.withOptions to return a configured Configurable Trait. This returns a trait that will look into the given options for the setter name given a key. If the key is not found, then it will default to set{Key} method.

Example: The class will use addItems instead of setItems since we want to add items to our items properties and will allow to pass an array or a single element.

MyClass.js


var cocktail     = require('cocktail'),
    Configurable = require('cocktail-trait-configurable');
    
cocktail.mix({
    '@exports': module,
    '@as'     : 'class',

    '@traits' : [
        Configurable.withOptions({ items: 'addItems' })
    ],
    
    '@properties': {
        prop: 'default value'
    },

    constructor: function() {
        this.items = [];
    },

    addItems: function (items) {
        this.items.concat(items);
    }

});

index.js


var MyClass = require('./MyClass'),
    options, obj, obj2;

options = {
    prop: 'value from options', 
    discarded: 'this should be discarded!',
    items: [1,2,3,4]
});

obj = new MyClass();

//use the configure method publicly
obj.configure(options);

console.log(obj.getProp()); //'value from options'
console.log(obj.items); // [1,2,3,4]

API

The following methods will be publicly available on the host class:

  • configure(options): calls every available setter per each key defined in the the options object.
    • options: {Object} the object with values that are going to be applied.