jkroso-protocol

An object orientated take on protocols

npm install jkroso-protocol
1 downloads in the last week
4 downloads in the last month

Protocol

An object orientated take on protocols

Getting Started

In the browser grab either the production version or the development version.

In Node.js

npm install ooprocol

API

var Protocol = require('protocol')

Protocol()

Create a new kind of abstraction

var Enumerable = createProtocol({
  first: function(){return this.value[0]},
  each: function(fn){
    for (var i = 0; i < this.value.length; i++) {
      fn(this.value[i])
    }
    return this
  }
})

dispatcher.get

Get the implementation of a certain type if it has one

enumerable.get(Array) -> [Function ArrayWrapper]

dispatcher.implement(type:Constructor, factory:Constructor)

Add an implementation for type to the protocol

enumerable.implement(String, function(value){
  this.value = value
})

dispatcher.extend(type:Constructor, add:Object)

Add methods to the protocols interface

enumerable.extend({
  toArray: function(){
    return Array.apply(null, this.value)
  }
})

Basic Usage

// example here

Contributing

Please do! And if looking at this project leads to any thoughts, perhaps its similar to something else, seems weak, or you wonder why I did something a certain way. let me know through github's issue system.

Release History

(Nothing yet)

License

Copyright (c) 2012 Jakeb Rosoman

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

npm loves you