@tequila99/pin-generator

Pin Name Generator

Генерация легко запоминаемых pin-кодов

Установка

npm install @tequila99/pin-generator --save

Начало работы

const generate = require('@tequila99/pin-generator');

generate(); // '7437'

generate({ length: 6, repetition: 3 }); // '338730'

Начиная с версии 1.1.0 добавлена возможность генерировать случайные буквенно-цифровые метки, удобные для использования в виде номера заказа или номера талона в системах электронных очередей.

Примеры использования:

const { hash } = require('@tequila99/pin-generator');

hash(); // 'ЖЮС-50175'
hash({ lang: 'en' }); // 'IK6-52805'
hash({ lang: 'ru', length: 2 }); // 'И7Ц-03'
hash({ lang: 'en', length 0 }); // 'Z7C'

API

Модуль возвращает обычную функцию, generate(options)

Аргумент options является объектом и содержит свойства:

• length (number) - длина pin кода в символах. Значение по умолчанию 4.
• repetition (boolean) - Количество гарантированных повторений одной из цифр в pin коде. Количество реальных повторений может быть и больше. Значение по умолчанию 2.

Аргументом функции hash (начиная с версии 1.1.0) так же является объект option, который содержит следующие свойства:

• length (number) - длина числового суффикса в символах. Может принимать значения от 0 до 5. Значение по умолчанию 5.
• lang (string) - Язык символьного словаря. Может принимать значения 'ru' или 'en'. Значение по умолчанию ru.

Тесты

Тестов пока нет, но планируются