Demo

import{expect}from"@rbxts/expect";importtfrom"@rbxts/t";enumSport{Basketball,Soccer,Football}expect(5).to.be.a.number().that.equals(5);expect("Daymon").to.have.the.substring("day");expect("Mom").to.be.a.string().that.has.a.sizeOf(3);expect(newVector3(1,2,3)).to.equal(newVector3(1,2,3));expect({name:"Daymon",age:24}).to.equal({name:"Daymon",age:24});expect(Sport.Basketball).to.be.the.enum(Sport,"Basketball");expect("Football").to.be.the.enum(Sport);expect(1).to.be.anyOf([1,2,3]);expect([]).to.be.empty();expect([1,2,3]).to.include(1);expect([1,2,3]).to.be.an.array();expect([1,2,3]).to.be.an.arrayOf("number");expect([1,2,3]).to.have.the.size(3);expect({name:"Daymon"}).to.be.an.object().but.not.an.array();expect(newVector3(1,2,3)).to.be.an.instanceOf("Vector3");expect("string").to.be.a.typeOf(t.string);

Installation

npm

npm install @rbxts/expect

pnpm

pnpm add @rbxts/expect

yarn

yarn add @rbxts/expect

Overview

Documentation

Features

Common matchers

expect(1).to.be.anyOf([1,2,3]);expect([]).to.be.empty();expect([1,2,3]).to.include(1);

Chainable matchers

expect([1,2,3]).to.be.an.array().that.is.not.empty().and.includes(1).but.does.not.include(4)

Array support

Expected '{"name": "Daymon"}' to be an array, but it had a non number key 'name' (string)

Expected '[1,2,3]' to be an array of type 'string', but there was an element that was a 'number'Index: 1Value: 1

Expected '[1,2]' to deep equal '[1]', but there were extra elementsExpected: '[1]'Actual: '[1,2]'Extra Elements: '[2]'

Enum support

Expected '5' (number) to be a valid enum of '(First | Second | Third)'

Expected 'Basketball' (enum/number) to be any of '["Football", "Soccer"'

Table property testing

Expected parent.cars to be empty, but it had 2 elements.parent.cars: '["Tesla","Civic"]'

Descriptive failure messages

Expected '{"name": "Daymon"}' to be an array, but it had a non number key 'name' (string)

Easy extensibility

Deep equals

Test-agnostic

import{expect}from"@rbxts/expect";import{remotes}from"./remotes";import{saves}from"./saves";import{pets}from"./data";remotes.purchasePet.connect(async(player,petId)=>{constdata=saves.get(player);constpet=pets.get(petId);expect(data.money,"You don't have enough money!").to.be.gte(pet.cost);data.money-=pet.cost;data.pets.push(pet);data.save();return"Pet purchased!";});

Getting Started

Roadmap

Contributing

License