Code Monkey home page Code Monkey logo

horsea's Introduction

Horsea

A tiny module for running simple unit tests.

Installation

npm install --save horsea

Example

const test = require('horsea');

const square = num => num * num;

test.block('When using the "square" function', () => {
  test.assert(square(4) === 16, 'The return value should be the square of the input value');
});

test.end();
$ node square.test.js 

When using the "square" function:

    PASS The return value should be the square of the input value

1 tests passed
0 tests failed

Usage

You always need to use require('horsea') in test files.
You can run the tests by usual node means (require('test-file.js') or node test-file.js).

Methods

block

Defines a new block of test assertions. The provided message is used as a block header.
This is mainly used as a way to neatly format output.

Arguments

{String} message - The block header to display. {Function} func - A function containing test assertions to run.

assert

If expression is truthy, the word "PASS" is printed, else the word "FAIL" is printed. The message provided is then displayed immediately afterwards.

Arguments

{Mixed} expression - An expression to evaluate for "truthiness".
{String} message - A message to display.

end

Signals the end of the test and prints the total number of failing and passed tests. Takes no arguments.

horsea's People

Watchers

James Cloos avatar Lucian Buzzo avatar  avatar

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.