# @lukeed/csprng

> An alias package for `crypto.randomBytes` in Node.js and/or browsers

Latest version **1.1.0** (published 2023-03-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install @lukeed/csprng
pnpm add @lukeed/csprng
yarn add @lukeed/csprng
bun add @lukeed/csprng
```

## 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.1.0 |
| Published | 2023-03-31 |
| First published | 2020-10-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Node | >=8 |
| Dependencies | 0 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 71 |
| Author | Luke Edwards |
| Maintainers | lukeed |
| Keywords | crypto, browser, isomorphic, getRandomValues, randomFill, random, csprng |

## Links

- npm: https://www.npmjs.com/package/@lukeed/csprng
- Repository: https://github.com/lukeed/csprng
- Homepage: https://github.com/lukeed/csprng#readme
- Issues: https://github.com/lukeed/csprng/issues
- npm.io page: https://npm.io/package/@lukeed/csprng

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 1.1.0 (latest) — 2023-03-31
- 1.0.1 — 2021-11-22
- 1.0.0 — 2020-10-27

## README

# @lukeed/csprng ![CI](https://github.com/lukeed/csprng/workflows/CI/badge.svg) [![codecov](https://badgen.now.sh/codecov/c/github/lukeed/csprng)](https://codecov.io/gh/lukeed/csprng)

> A tiny (~90B) isomorphic wrapper for `crypto.randomBytes` in Node.js and browsers.

***Why?***

This package allows you/dependents to import a cryptographically secure generator (CSPRNG) _without_ worrying about (aka, checking the runtime environment for) the different `crypto` implementations. Instead, by extracting a `random` function into a third-party/external package, one can rely on bundlers and/or module resolution to load the correct implementation for the desired environment.

In other words, one can include the browser-specific implementation when bundling for the browser, completely ignoring the Node.js code – or vice versa.

By default, this module is set up to work with Rollup, webpack, and Node's native ESM _and_ CommonJS path resolutions.

## Install

```
$ npm install --save @lukeed/csprng
```


## Usage

***General Usage***

```js
// Rely on bundlers/environment detection
import { random } from '@lukeed/csprng';

const array = random(12);
// browser => Uint8Array(12) [...]
// Node.js => <Buffer ...>
```

***Specific Environment***

```js
// Choose the "browser" implementation explicitly.
//=> ! NOTE ! Will break in Node.js environments!
import { random } from '@lukeed/csprng/browser';

const array = random(1024);
//=> Uint8Array(1024) [...]

// ---

// Choose the "node" implementation explicitly.
//=> ! NOTE ! Will break in browser environments!
import { random } from '@lukeed/csprng/node';

const array = random(1024);
//=> <Buffer ...>
```


## API

### random(length)
Returns: `Buffer` or `Uint8Array`

Returns a typed array of given `length`.


#### length
Type: `Number`

The desired length of your output TypedArray.


## Related

- [uid](https://github.com/lukeed/uid) - A tiny (134B) and fast utility to randomize unique IDs of fixed length
- [@lukeed/uuid](https://github.com/lukeed/uuid) - A tiny (230B), fast, and cryptographically secure UUID (V4) generator for Node and the browser


## License

MIT © [Luke Edwards](https://lukeed.com)

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