# @openpassport/zk-kit-utils

> Essential zero-knowledge utility library for JavaScript developers.

Latest version **0.0.1** (published 2024-10-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install @openpassport/zk-kit-utils
pnpm add @openpassport/zk-kit-utils
yarn add @openpassport/zk-kit-utils
bun add @openpassport/zk-kit-utils
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2024-10-27 |
| First published | 2024-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 405.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | nicoshark, turnoffthiscomputer, 0xturboblitz |

## Links

- npm: https://www.npmjs.com/package/@openpassport/zk-kit-utils
- Repository: https://github.com/zk-passport/zk-kit
- Homepage: https://www.openpassport.app/
- Issues: https://github.com/zk-passport/zk-kit/issues
- npm.io page: https://npm.io/package/@openpassport/zk-kit-utils

## Dependencies (1)

- [buffer](https://npm.io/package/buffer.md) ^6.0.3

## Recent versions

- 0.0.1 (latest) — 2024-10-27

## README

<p align="center">
    <h1 align="center">
        Utils
    </h1>
    <p align="center">Essential zero-knowledge utility library for JavaScript developers.</p>
</p>

<p align="center">
    <a href="https://github.com/privacy-scaling-explorations/zk-kit">
        <img src="https://img.shields.io/badge/project-zk--kit-blue.svg?style=flat-square">
    </a>
    <a href="https://github.com/privacy-scaling-explorations/zk-kit/tree/main/packages/utils/LICENSE">
        <img alt="NPM license" src="https://img.shields.io/npm/l/%40zk-kit%2Futils?style=flat-square">
    </a>
    <a href="https://www.npmjs.com/package/@zk-kit/utils">
        <img alt="NPM version" src="https://img.shields.io/npm/v/@zk-kit/utils?style=flat-square" />
    </a>
    <a href="https://npmjs.org/package/@zk-kit/utils">
        <img alt="Downloads" src="https://img.shields.io/npm/dm/@zk-kit/utils.svg?style=flat-square" />
    </a>
    <a href="https://bundlephobia.com/package/@zk-kit/utils">
        <img alt="npm bundle size (scoped)" src="https://img.shields.io/bundlephobia/minzip/@zk-kit/utils" />
    </a>
    <a href="https://eslint.org/">
        <img alt="Linter eslint" src="https://img.shields.io/badge/linter-eslint-8080f2?style=flat-square&logo=eslint" />
    </a>
    <a href="https://prettier.io/">
        <img alt="Code style prettier" src="https://img.shields.io/badge/code%20style-prettier-f8bc45?style=flat-square&logo=prettier" />
    </a>
</p>

<div align="center">
    <h4>
        <a href="https://appliedzkp.org/discord">
            🗣️ Chat &amp; Support
        </a>
        <span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>
        <a href="https://zkkit.pse.dev/modules/_zk_kit_utils.html">
            📘 Docs
        </a>
    </h4>
</div>

> [!NOTE]  
> This library has been audited as part of the Semaphore V4 PSE audit: https://semaphore.pse.dev/Semaphore_4.0.0_Audit.pdf.

## 🛠 Install

### npm or yarn

Install the `@zk-kit/utils` package and its peer dependencies with npm:

```bash
npm i @zk-kit/utils
```

or yarn:

```bash
yarn add @zk-kit/utils
```

### CDN

You can also load it using a `script` tag using [unpkg](https://unpkg.com/):

```html
<script src="https://unpkg.com/@zk-kit/utils"></script>
```

or [JSDelivr](https://www.jsdelivr.com/):

```html
<script src="https://cdn.jsdelivr.net/npm/@zk-kit/utils"></script>
```

## 📜 Usage

```typescript
// You can import modules from the main bundle.
import { errorHandlers, typeChecks } from "@zk-kit/utils"

// Or by using conditional exports.
import { requireNumber } from "@zk-kit/utils/error-handlers"
import { isNumber } from "@zk-kit/utils/type-checks"
```

For more information on the functions provided by `@zk-kit/utils`, please refer to the [documentation](https://zkkit.pse.dev/modules/_zk_kit_utils.html).

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