randomString

• randomString
• RandomStringOptions

生成长度为length的随机字符串，options参数用于指定字符的取值范围，默认为大小写英文字母和数字。

Added in v0.0.2

Usage

import { randomString } from 'parsnip-kit'

randomString(10)
// a string including uppercase letters, lowercase letters, numbers, for example 'Dij1mzPzyW'

randomString(10, { number: false })
// a string only including letters, for example 'iYyyWSReNw'

randomString(10, { uppercase: false, lowercase: false })
// a string only including numbers, for example '2398543147'

randomString(10, { symbol: true })
// a string including uppercase letters, lowercase letters, numbers and symbols
// for example 'gI(CThCMK%'

randomString(
  10,
  {
    uppercase: false, lowercase: false, number: false,
    customized: 'αβγδεζηθικλμνξοπρστυφχψω'
  }
)
// a string only including lowercase Greek letters, for example 'γμχβωζπθοχ'

API

Arguments

Arg	Type	Optional	Default	Description
length	number	false	undefined	待生成的字符串长度
options	RandomStringOptions	true	undefined	生成字符串的选项
options.lowercase	boolean	true	true	Whether to include lowercase letters
options.uppercase	boolean	true	true	Whether to include uppercase letters
options.number	boolean	true	true	Whether to include numbers
options.symbol	boolean	true	false	Whether to include symbols: `'!@#$%^&*()_+-=[]{}
options.customized	string	true	undefined	Included custom characters

Returns

Type
string

RandomStringOptions

randomString函数的参数options的类型。

Added in v0.0.2

Source

export interface RandomStringOptions {
  lowercase?: boolean
  uppercase?: boolean
  number?: boolean
  symbol?: boolean
  customized?: string
}