@tspec/assert

Assertion library for TSpec testing framework

ℹ️ Important Note

Provides the expect() function and comprehensive assertion methods for testing.

This package is designed to work as part of the TSpec ecosystem and Must be used with @tspec/core for test organization.

📖 View complete documentation and examples →

Installation

1npm install --save-dev @tspec/core @tspec/assert

Features

• 16+ assertion methods covering all common use cases
• Promise testing with resolves and rejects
• Type-safe assertions with full TypeScript support
• Clear, descriptive error messages

Usage

1import { expect } from '@tspec/assert';
2
3// Basic assertions
4expect(2 + 2).toBe(4);
5expect('hello world').toContain('world');
6expect([1, 2, 3]).toHaveLength(3);
7
8// Async assertions
9await expect(fetchData()).resolves.toEqual({ data: 'value' });
10await expect(failingFunction()).rejects.toThrow('Error message');

Complete Testing Example

1import { describe, test } from '@tspec/core';
2import { expect } from '@tspec/assert';
3
4
5describe('assert Example', () => {
6  test('demonstrates assert functionality', () => {
7    
8    // Comprehensive assertions
9    expect(42).toBe(42);
10    expect('hello').toContain('ell');
11    expect([1, 2, 3]).toHaveLength(3);
12    
13  });
14});

Related Packages

TSpec is designed as a cohesive framework. Here are the related packages:

• @tspec/core - Core testing framework functionality for TSpec
• @tspec/mock - Mocking and spying utilities for TSpec testing framework

Documentation & Support

• 📖 Complete Documentation - Full usage guide and API reference
• 🚀 Getting Started Guide - Step-by-step setup
• 💡 Examples - Real-world usage examples
• 🐛 Issues - Report bugs or request features

Contributing

We welcome contributions! Please see our Contributing Guide for details on:

• Setting up the development environment
• Running tests and ensuring quality
• Submitting pull requests

License

MIT License - see the LICENSE file for details.

---