Giter VIP home page Giter VIP logo

node-implement's Introduction

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).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.