Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v2.0.3 #24

Merged
merged 6 commits into from
Oct 13, 2024
Merged

Release v2.0.3 #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c4dcfe8
Add shell.nix to prepare dev environment
May 29, 2024
9e65471
Merge pull request #22 from sibevin/add-shell-nix-file
sibevin May 29, 2024
ab17611
pkg: Fix npm audit
Oct 13, 2024
ce3f08e
doc: Update README
Oct 13, 2024
9e975a6
release: v2.0.3
Oct 13, 2024
de9aaac
Merge pull request #23 from sibevin/release-v2.0.3
sibevin Oct 13, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

A simple way to generate a random token.

## Usage
# Usage

Import package first

Expand All @@ -28,9 +28,9 @@ Or just simplify as:
RandomToken.gen({ length: 32, seed: 'a', casing: 'u', mask: 'ABC', friendly: true })
// DNJERZGWGJQTFYGYWGHAZEBGBRQFPHPF

## Options
# Options

### Seed
## Seed

Use `seed` option to customize the random characters. Here are available options:

Expand Down Expand Up @@ -64,7 +64,7 @@ Use a string to customize random seeds.
RandomToken.gen({ length: 32, seed: 'abc' })
// bcabcbbcaaabcccabaabcacbcbbabbac

### Casing
## Casing

Use `casing` option to modify the token case. Here are available options:

Expand All @@ -88,14 +88,14 @@ Casing is not supported with following `seed` options: `'number'`, `'binary'`, `
RandomToken.genf({ length: 32, seed: 'number', casing: 'l' })
// Error: Invalid Parameters: casing. The casing is not supported with number seeds

### Mask
## Mask

Use `mask` option to filter characters which you don't want to appear on the generated token.

RandomToken.gen({ length: 32, mask: '123abcABC' })
// vhZp88dKzRZGxfQHqfx7DOL8jKTkWUuO

### Friendly
## Friendly

Use `friendly` option to remove the ambiguous characters, the default mask includes _1, I, l, i, 0, O, o, Q, D, C, c, G, 9, 6, U, u, V, v, E, F, M, N, 8, B_.

Expand All @@ -112,14 +112,20 @@ Note that the friendly option is supported with alphabet or random-generated see
RandomToken.genf({ length: 32, seed: 'abc' })
// Error: Invalid Parameters: friendly. The friendly mask is supported with alphabet or random-generated seeds (no "seed" is given) only.

## Test
# Test

npm run test

## Authors
# Support

Sibevin Wang
Support the continuous development of the project with concrete actions. Any form of help means a lot to us.

## Copyright
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/kaitwang)

Copyright (c) 2019-2024 Sibevin Wang. Released under the MIT license.
# Authors

Kait Wang

# Copyright

Copyright (c) 2019-2024 Kait Wang. Released under the MIT license.
Loading