# @windingtree/sdk-test-utils

> Testing utilities for the Windingtree market protocol SDK

Latest version **1.2.3** (published 2024-01-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install @windingtree/sdk-test-utils
pnpm add @windingtree/sdk-test-utils
yarn add @windingtree/sdk-test-utils
bun add @windingtree/sdk-test-utils
```

## Health

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

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

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.3 |
| Published | 2024-01-17 |
| First published | 2023-07-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 8.9 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Kostiantyn Smyrnov |
| Maintainers | valera_rozuvan, kostysh, kvakes, tomashq |

## Links

- npm: https://www.npmjs.com/package/@windingtree/sdk-test-utils
- Repository: https://github.com/windingtree/sdk.git#readme
- Homepage: https://github.com/windingtree/sdk/tree/readme#readme
- Issues: https://github.com/windingtree/sdk/issues
- npm.io page: https://npm.io/package/@windingtree/sdk-test-utils

## Dependencies (4)

- [viem](https://npm.io/package/viem.md) ^1.19.13
- [vitest](https://npm.io/package/vitest.md) ^1.0.4
- [@windingtree/contracts](https://npm.io/package/@windingtree/contracts.md) ^1.0.0
- [@windingtree/sdk-types](https://npm.io/package/@windingtree/sdk-types.md) 1.1.4

## Recent versions

- 1.2.3 (latest) — 2024-01-17
- 1.2.3-beta.0 (beta) — 2024-01-17
- 1.2.2 — 2023-12-11
- 1.2.1 — 2023-10-31
- 1.2.0 — 2023-10-25
- 1.2.0-beta.1 — 2023-10-25
- 1.2.0-beta.0 — 2023-07-31
- 1.1.0 — 2023-07-27
- 1.1.0-beta.3 — 2023-07-27
- 1.1.0-beta.2 — 2023-07-27
- 1.1.0-beta.1 — 2023-07-23
- 1.1.0-beta.0 — 2023-07-23

## README

# @windingtree/sdk-test-utils

The `@windingtree/sdk-test-utils` package is a utility package designed for testing purposes within the Winding Tree SDK. It extends the capabilities of the [vitest](https://github.com/vitest-dev/vitest) test runner with a custom function for validating deep equality of objects, more features will be added later.

## Installation

```bash
pnpm i @windingtree/sdk-test-utils
```

## Key concepts

- `expectDeepEqual`: This function is used to validate the deep equality of two objects. It compares two objects recursively and expects every single key in the first object to be equal to the corresponding key in the second object.

## Usage

Here is a simplified example of how you can use the `@windingtree/sdk-test-utils` package:

```typescript
import { test, expectDeepEqual } from '@windingtree/sdk-test-utils';

test('deep equality of objects', () => {
  const obj1 = {
    key1: 'value1',
    key2: {
      nestedKey1: 'nestedValue1',
      nestedKey2: 'nestedValue2',
    },
  };

  const obj2 = {
    key1: 'value1',
    key2: {
      nestedKey1: 'nestedValue1',
      nestedKey2: 'nestedValue2',
    },
  };

  expectDeepEqual(obj1, obj2);
});
```

## Documentation

For full documentation and examples, visit [windingtree.github.io/sdk](https://windingtree.github.io/sdk)

## Testing

```bash
pnpm test
```

## Contributing

[Contribution guidelines](https://windingtree.github.io/sdk/#/docs/contribution)

---
_Source: https://npm.io/package/@windingtree/sdk-test-utils · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._