スタンプID

について

パターンごとに ID を生成および検証するライブラリ。

インストール

npm i stamp-id

例

一般的な使用法

 import stampId from 'stamp-id'

// generate
const id = stampId.generate()

// validate
const isValid = stampId.validate(id)

例を生成する

"[phone]" // 3 stampId.setAlphabet('R', 'AAAAAAAAAB') const id = stampId.generate('R') // --> "A" (90% probability) or "B" (10% probability)">

 // 1
const id = stampId.generate('ddd-dd-dddd')
// --> "253-15-7920

// 2
stampId.setAlphabet('N', '23456789')
const id = stampId.generate('+1 Ndd-Ndd-dddd')
// --> "[phone]"

// 3
stampId.setAlphabet('R', 'AAAAAAAAAB')
const id = stampId.generate('R')
// --> "A" (90% probability) or "B" (10% probability)

内蔵アルファベット

 'b': '01',
'd': '0123456789',
'h': '0123456789abcdef',
'H': '0123456789ABCDEF',
'c': 'abcdefghijklmnopqrstuvwxyz',
'C': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ',
'a': 'abcdefghijklmnopqrstuvwxyz0123456789',
'A': 'ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789',
'z': 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789',

例を検証する

 // 1
const id = 'FRIDAY13'
const isValid = stampId.validate(id, 'CCCCCC13')
// --> true

// 1
stampId.setAlphabet('?', '-+./')`
const id = 'a0+b1/z9.gg-zz'
const isValid = stampId.validate(id, 'aa?aa?aa?aa?aa')
// --> true

API

生成([パターン]) ⇒ string

新しいランダム ID を生成します。

validate(id, [パターン], [フラグ]) ⇒ boolean

パターンに対して ID を検証します。

setAlphabet(コード, abc)

新しいアルファベットを追加するか、既存のアルファベットを更新します。

生成([パターン]) ⇒ string

新しいランダム ID を生成します。

種類: グローバル関数
戻り値: string - ランダムな ID。

パラム	タイプ	デフォルト	説明
[パターン]	string	"zzzzzzzz"	目的の ID のテキスト パターン。

validate(id, [パターン], [フラグ]) ⇒ boolean

パターンに対して ID を検証します。

種類: グローバル関数
戻り値: boolean - パターンを使用して ID を生成できた場合は True。

パラム	タイプ	デフォルト	説明
ID	string		テストする ID。
[パターン]	string	"zzzzzzzz"	テキストパターン。
[フラグ]	string		フラグ文字列 (「i」は大文字と小文字を区別しないことを意味します)。

setAlphabet(コード, abc)

新しいアルファベットを追加するか、既存のアルファベットを更新します。

種類: グローバル関数

パラム	タイプ	説明
コード	string	パターンで使用される 1 つの文字。
ABC	string	アルファベット文字。