@ack_inc/rand-str 中文文档教程
node-rand-str
生成指定长度的随机字符串（小写/大写字母、数字、符号）， 并满足指定的约束条件
如果未指定约束条件，则库假定允许使用所有字符
主要用例：密码或临时令牌生成
Deprecation Notice
自 2021 年 5 月 9 日起，此功能已被纳入.npmjs.com/package/@ack_inc/utils">ack_inc/node-utils repo
这个包将不再更新
Usage
const rsg = require('@ack_inc/rand-str');
console.log(rsg(<anything but a whole number>)); //=> throws TypeError
console.log(rsg(0)); //=> ""
console.log(rsg(5)); //=> "3`8aE"
console.log(rsg(5, { lowercase: true })); //=> "fewjk"
console.log(rsg(5, { lowercase: true, uppercase: true, digits: true, symbols: true })); //=> "%q31G"
API
rsg(nChars, constraints)
生成一个长度为 nChars 的字符串，满足 constraints< /代码>
Parameters
nChars
必需。 必须是整数。
constraints
指定生成的字符串中可以包含哪些字符的对象。 它可以具有以下键：
| Key | Type | Effect |
|---|---|---|
| lowercase | Boolean | if true, include lowercase characters |
| uppercase | Boolean | if true, include uppercase chracters |
| digits | Boolean | if true, include digits |
| symbols | Boolean | if true, include symbols |
如果 constraints 未提供或为空，则假定允许所有字符
To Do
- Constraint: whitelisted chars
- Constraint: blacklisted chars
- Constraint: symbols that can be part of a url-component (See https://stackoverflow.com/questions/695438/what-are-the-safe-characters-for-making-urls)
node-rand-str
Generate a random string (lower/upper alphabets, digits, symbols) of specified length, and satisfying the specified constraints
If no constraints are specified, the library assumes all characters are allowed
Main use case: password or temporary token generation
Deprecation Notice
As of 9 May 2021, this function has been subsumed into the ack_inc/node-utils repo
This package will no longer be updated
Usage
const rsg = require('@ack_inc/rand-str');
console.log(rsg(<anything but a whole number>)); //=> throws TypeError
console.log(rsg(0)); //=> ""
console.log(rsg(5)); //=> "3`8aE"
console.log(rsg(5, { lowercase: true })); //=> "fewjk"
console.log(rsg(5, { lowercase: true, uppercase: true, digits: true, symbols: true })); //=> "%q31G"
API
rsg(nChars, constraints)
Generate a string of length nChars that satisfies constraints
Parameters
nChars
Required. Must be a whole number.
constraints
Object specifying what characters can be in the generated string. It can have the following keys:
| Key | Type | Effect |
|---|---|---|
| lowercase | Boolean | if true, include lowercase characters |
| uppercase | Boolean | if true, include uppercase chracters |
| digits | Boolean | if true, include digits |
| symbols | Boolean | if true, include symbols |
If constraints is not provided or is empty, it is assumed that all characters are allowed
To Do
- Constraint: whitelisted chars
- Constraint: blacklisted chars
- Constraint: symbols that can be part of a url-component (See https://stackoverflow.com/questions/695438/what-are-the-safe-characters-for-making-urls)
