mentsu-random-text-generator

A random text generator that builds strings of any length from a customizable character set.

Installation

Requires Node.js 20.x (the version the CI builds against).

npm install @openreachtech/mentsu-random-text-generator

When using GitHub Packages (the @openreachtech scope), the following two items are required:

1. Add the registry to your project's .npmrc:

   @openreachtech:registry=https://npm.pkg.github.com

2. Authenticate with npm login:

   npm login --registry https://npm.pkg.github.com

It is an ES module ("type": "module"); import it with ESM import syntax.

Usage

Create a generator and generate a random string. With no arguments, it draws from 0-9A-Za-z (62 characters) and produces 10 characters.

import { RandomTextGenerator } from '@openreachtech/mentsu-random-text-generator'

const generator = RandomTextGenerator.create()

const text = generator.generate()
// e.g. 'aZ3kR9mQ1x' (10 characters from 0-9A-Za-z)

Pass seedString to restrict the character set, and length to change the output size.

const generator = RandomTextGenerator.create({
  seedString: '0123456789',
})

const text = generator.generate({
  length: 6,
})
// e.g. '481920' (6 digits)

API

Class members are written with the following notation.

| notation | members | | :-- | :-- | | #instanceProperty | instance property | | #instanceMethod() | instance method | | #get:instanceGetter | instance getter | | #set:instanceSetter | instance setter | | .staticProperty | static property | | .staticMethod() | static method | | .get:staticGetter | static getter | | .set:staticSetter | static setter |

.create()

Factory method that returns a new instance.

RandomTextGenerator.create({ seedString })

| parameter | type | default | description | | :-- | :-- | :-- | :-- | | seedString | string | '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz' | Characters to draw from. |

Returns a RandomTextGenerator instance.

#generate()

Generates a random string by picking characters from the seed set.

generator.generate({ length })

| parameter | type | default | description | | :-- | :-- | :-- | :-- | | length | number | 10 | Number of characters to generate. |

Returns a string.

#seeds

The array of characters used for generation. It is the seedString split into code points, so multi-byte characters are kept intact.

const generator = RandomTextGenerator.create({
  seedString: 'ab#',
})

generator.seeds
// ['a', 'b', '#']

Contribution

Bug reports, feature requests, and code contributions are welcome.

Feel free to contact us through GitHub Issues.

git clone https://github.com/openreachtech/mentsu-random-text-generator.git
cd mentsu-random-text-generator
npm install
npm run lint
npm test

License

This project is released under the MIT License.

For more details, please see in the LICENSE file.

Developer

Open Reach Tech Inc.

Copyright

© 2026 Open Reach Tech Inc.