Readme.md

Generate random string

This package will generate a random dummy string based on the available set of characters or provided ones, and you can also indicate the length of your desired random string. In case you don't care about uniqueness and don't want to use UUID, this package will help you to achieve what you want.

Generated characters and the default length use the Web Crypto API. The function throws if secure randomness is unavailable rather than falling back to Math.random().

Node.js 20 or later is required. In browsers, the Web Crypto API must be available.

If you're in need of a UUID generation library, take a look at @smakss/uuid, which offers robust UUID creation capabilities. For those who require more tailored options, @smakss/password-generator provides a versatile solution for crafting custom passwords to fit a variety of needs.

Demo

How it works?

Install the package using npm or pnpm:

npm install @smakss/random-string
# or
pnpm add @smakss/random-string

To include it with a common js module you should do this:

const { default: randomString } = require('@smakss/random-string');

And to include it with an ECMAScript module you can simply do this one:

import randomString from '@smakss/random-string';

Examples of usage

Then to use it within your application you can do it just like this:

Generate a random string with default parameters:

randomString();

// Result example: 'GkL9#z$P!2'

NOTE: If the length is not provided, it will be selected randomly between 1 and 20.

Generate a random string with a specified length:

randomString({ length: 10 });

// Result example: 'Sg67&ZpQ8!'

You can provide both length and allowed characters:

randomString({ length: 10, allowedCharacters: 'abCD#@' });

// Result example: 'b@@#aDaC##'

Contributing

Interested in making contributions to this project? Please see CONTRIBUTING.md for guidelines and details.

Code of Conduct

We value and prioritize the well-being of all our contributors and users. To ensure that this project remains a welcoming space for everyone, please refer to our Code of Conduct.

Local playground

This repository includes a Vite playground linked to the package through the pnpm workspace. Try the current local build without publishing a package version:

pnpm install
pnpm run dev:playground

To build the playground app, run this from the package root:

pnpm run build:playground