Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/unjs/uncrypto
Single API for Web Crypto API and Crypto Subtle working in Node.js, Browsers and other runtimes
https://github.com/unjs/uncrypto
Last synced: 4 months ago
JSON representation
Single API for Web Crypto API and Crypto Subtle working in Node.js, Browsers and other runtimes
- Host: GitHub
- URL: https://github.com/unjs/uncrypto
- Owner: unjs
- License: mit
- Created: 2023-02-06T20:27:11.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-01-29T20:37:20.000Z (about 1 year ago)
- Last Synced: 2024-01-30T13:11:19.098Z (about 1 year ago)
- Language: TypeScript
- Size: 140 KB
- Stars: 146
- Watchers: 4
- Forks: 9
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# uncrypto
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions][github-actions-src]][github-actions-href]
[![Codecov][codecov-src]][codecov-href]
This library provides a single api to use [web-crypto](https://developer.mozilla.org/en-US/docs/Web/API/Web_Crypto_API) and [Subtle Crypto](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto) in both Node.js using [Crypto Module](https://nodejs.org/api/crypto.html#crypto) and Web targets using [Web Crypto API](https://nodejs.org/api/crypto.html#crypto) using [Conditional Exports](https://nodejs.org/api/packages.html#conditional-exports).
**Requirements:**
- **Node.js**: Version **15 and above** (this library provides no polyfills for older versions!)
- **Browser**: [Secure Context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts) (HTTPS/Localhost) in [Supported Browsers](https://developer.mozilla.org/en-US/docs/Web/API/SubtleCrypto#browser_compatibility)
- **Other Runtimes:** Exposed `globalThis.crypto` and `globalThis.crypto.subtle`. (you can polyfill if neeeded)
## Usage
Install package:
```sh
# npm
npm install uncrypto
# yarn
yarn add uncrypto
# pnpm
pnpm install uncrypto
```
Import:
```js
// ESM
import { subtle, randomUUID, getRandomValues } from "uncrypto";
// CommonJS
const { subtle, randomUUID, getRandomValues } = require("uncrypto");
```
## Development
- Clone this repository
- Install latest LTS version of [Node.js](https://nodejs.org/en/)
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`
- Run interactive tests using `pnpm dev`
## License
Made with 💛
Published under [MIT License](./LICENSE).
[npm-version-src]: https://img.shields.io/npm/v/uncrypto?style=flat-square
[npm-version-href]: https://npmjs.com/package/uncrypto
[npm-downloads-src]: https://img.shields.io/npm/dm/uncrypto?style=flat-square
[npm-downloads-href]: https://npmjs.com/package/uncrypto
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/unjs/uncrypto/ci.yml?branch=main&style=flat-square
[github-actions-href]: https://github.com/unjs/uncrypto/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/gh/unjs/uncrypto/main?style=flat-square
[codecov-href]: https://codecov.io/gh/unjs/uncrypto