implement

Install

npm install implement

Javascript

Demonstrated using mocha

// test.implement.js
 
"use strict"
 
const implement = require("implement")
 
// LIFO.
function Queue() {}
Queue.prototype = {
    offer: function (e) {},
    poll: function () {},
    peek: function () {}
}
 
// Queue backed by array.
function ArrayQueue() {}
ArrayQueue.prototype = {
    offer: function (e) {},
    poll: function () {},
    peek: function () {}
}
       
// FIFO.
function Stack() {}
Stack.prototype = {
    peek: function () {},
    pop: function () {},
    push: function () {}
}
 
 
describe("implement", function () {
    it("should not throw error when implementing interface", function (done) {
        implement(ArrayQueue, Queue)
        done()
    })
    
    it("Should throw error when not implementing interface", function (done) {
        try {
            implement(Stack, Queue)
        } catch (error) {
            console.log(error.message)
            done()        
        }
    })
})
 

Run

mocha test.js

Todo

• Automically update tests in this document. Usefull for other projects as well. Probably should make this a seperate module or something?
• Let it read jsdoc too and ensure types. This would be really cool? Use http://ariya.ofilabs.com/2014/04/tracking-javascript-annotations.html as baseline?
• Add test coverage. I assume it is 100% or close to this. Not that it really matters.
• Better documentation(generation).