# umbra-assert

> Assertion library included with the Umbra Test packages.

Latest version **0.0.5** (published 2020-05-14) · MIT license · 0 weekly downloads

## Install

```sh
npm install umbra-assert
pnpm add umbra-assert
yarn add umbra-assert
bun add umbra-assert
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.5 |
| Published | 2020-05-14 |
| First published | 2020-04-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 44.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | umbra-test authors |
| Maintainers | buckeyedude |

## Links

- npm: https://www.npmjs.com/package/umbra-assert
- Repository: https://github.com/umbra-test/umbra-assert
- Homepage: https://github.com/umbra-test/umbra-assert#readme
- Issues: https://github.com/umbra-test/umbra-assert/issues
- npm.io page: https://npm.io/package/umbra-assert

## Dependencies (1)

- [@umbra-test/umbra-util](https://npm.io/package/@umbra-test/umbra-util.md) 0.0.4

## Recent versions

- 0.0.5 (latest) — 2020-05-14
- 0.0.4 — 2020-05-14
- 0.0.3 — 2020-05-06
- 0.0.2 — 2020-04-20
- 0.0.1 — 2020-04-18

## README

# Umbra Assert
Umbra assertion is an assertion framework built to be expressive and simple. It's focus is on making writing tests easier and less error prone. Let's take a look at some simple examples.

## Features
* Automatic deep equals checks
* Expect and Assert style expectations

## Examples

String comparison
```
const actual = "hello " + "world";
Assert.equals(actual, "hello world");
expect(actual).toBe("hello world");
```

Object comparison
```
const actual = {
    
};
Assert.equals(actual, "hello world");
expect(actual).toBe("hello world");
```

---
_Source: https://npm.io/package/umbra-assert · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
