@nevware21/tripwire

Modern assertion library for testing JavaScript and TypeScript packages across Node.js, Browser, and Web Worker environments.

Why Tripwire?

Cross-Environment Testing

• Works seamlessly in Node.js, browsers, and Web Workers
• Comprehensive support from ES5+ for broad compatibility
• Tested across all three environments

Dual API Design

• Use familiar assert.* functions for quick checks
• Use fluent expect().to.be.* syntax for readable tests
• Mix both styles in the same test suite

Reliable & Lightweight

• Minimal dependencies to prevent build breakages
• Built with TypeScript for full type safety
• No dependency on unstable or unmaintained packages

Installation

npm install @nevware21/tripwire --save-dev

Recommended version range:

{
  "devDependencies": {
    "@nevware21/tripwire": ">= 0.1.8 < 2.x"
  }
}

Quick Start

import { assert, expect } from '@nevware21/tripwire';

// Assert style
assert.equal(1 + 1, 2);
assert.isString("hello");
assert.deepEqual({ a: 1 }, { a: 1 });

// Expect style
expect(1 + 1).to.equal(2);
expect("hello").to.be.a.string;
expect({ a: 1 }).to.deep.equal({ a: 1 });

Key Features

• Type Checking - isObject, isArray, isString, isNumber, isBoolean, isFunction, isNull, isUndefined, isNaN, isFinite, typeOf, instanceOf, exists
• Equality - equal, strictEqual, deepEqual, closeTo (approximate equality)
• Comparisons - above, below, within, atLeast, atMost, operator (generic comparison)
• Properties - property, ownProperty, deepProperty, nestedProperty with value validation
• Collections - include, keys, members with deep equality and ordered comparison
• Deep Keys - hasAnyDeepKeys, hasAllDeepKeys for Maps/Sets with object keys using deep equality
• Size/Length - lengthOf, sizeOf for arrays, strings, maps, sets
• Array Operations - subsequence, endsWith, oneOf matching
• Change Tracking - Monitor value changes, increases, decreases with delta validation
• Error Testing - throw, throws, doesNotThrow, ifError with type and message validation
• Object State - isExtensible, isSealed, isFrozen, isEmpty

Documentation

Quick Start & Examples: Documentation Guide

API Reference: TypeDoc Documentation

Guides:

• Change/Increase/Decrease Assertions
• Expression Adapter Guide

Migration Guides:

• Migrating from Node.js Native Assert
• Migrating from Chai

Repository: github.com/nevware21/tripwire

Browser Support

• Comprehensive support from ES5+ for broad browser compatibility, from IE9+
• Tested in Node.js, Chrome, Firefox, Safari, Edge
• Full Web Worker support

Related Packages

@nevware21/tripwire-chai - Chai.js compatibility shim

Contributing

See Contributing Guide

License

This project is licensed under the MIT License. See the LICENSE file for details.