JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 15
  • Score
    100M100P100Q42642F
  • License MIT

Tiny assertion library

Package Exports

  • claim

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (claim) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

claim Build Status

Tiny assertion library

Install

$ npm install --save claim

Usage

var claim = require('claim');

claim.true(true);
claim.false(false);
claim.is('foo', 'foo');
claim.not('foo', 'bar');
claim.same({a: 'a'}, {a: 'a'});
claim.same(['a', 'b'], ['a', 'b']);
claim.notSame({a: 'a'}, {a: 'b'});
claim.notSame(['a', 'b'], ['c', 'd']);

API

.true(value, message)

Assert that value is true with an optional description message.

value

Required
Type: boolean

Value to be tested.

message

Type: string

Message to be shown upon failure.

.false(value, message)

Assert that value is false with an optional description message.

value

Required
Type: boolean

Value to be tested.

message

Type: string

Message to be shown upon failure.

.is(value, expected, message)

Assert that value is equal to expected with an optional description message.

value

Required
Type: mixed

Value to be tested.

expected

Required
Type: mixed

Value to be tested against.

message

Type: string

Message to be shown upon failure.

.not(value, expected, message)

Assert that value is not equal to expected with an optional description message.

value

Required
Type: mixed

Value to be tested.

expected

Required
Type: mixed

Value to be tested against.

message

Type: string

Message to be shown upon failure.

.same(value, expected, message)

Assert that value is deep equal to expected with an optional description message.

value

Required
Type: mixed

Value to be tested.

expected

Required
Type: mixed

Value to be tested against.

message

Type: string

Message to be shown upon failure.

.notSame(value, expected, message)

Assert that value is not deep equal to expected with an optional description message.

value

Required
Type: mixed

Value to be tested.

expected

Required
Type: mixed

Value to be tested against.

message

Type: string

Message to be shown upon failure.

.error(error, message)

Assert that error is false with an optional description message.

error

Required
Type: mixed

Value to be tested.

message

Type: string

Message to be shown upon failure.

License

MIT © Kevin Mårtensson