serial-pin-generator

A simple JavaScript script that enable developers to generate pin digits and corresponding serial numbers in application that require something like scratch card or recharge card services. it is a promise base script. Although pin and serial numbers are not each expected to be more than 25 characters long, but this script can generate up to 64 character long for each (pin or serial number).

Installation

npm install serial-pin-generator

Usage

install via npm

npm i serial-pin-generator

or via yarn

yarn add serial-pin-generator

require it in your file

const pinGen = require('serial-pin-generator');

Calling the pinGen function will return a promise which will resove with an array of objects.

pinGen()
.then(values => console.log(values))
.catch(err => console.log(err));

Syntax

pinGen([options])

The function accept object as argument. The argument is optional. it is provided to configure the output of the pin digits and the serial numbers that will be generated.

Setting the optional option argument

pinGen({
    pinLength: 5,
    serialNumLength: 15,
    prefixCharacters: 'sdp',
    numberRequired: 7,
    numberRequired: 5
}).then(values =>console.log(values))
  .catch(err => console.log(err));

is equivalent to this

pinGen({
    serialNumLength : {
        length: 15,
        includePrefixLength: true
    },
    prefixCharacters: 'sdp',
    numberRequired: 7,
    pinLength: 8
})
.then(values => console.log(values))
.catch(err => console.log(err.message));

Which generates

[
  { pin: 62511243, serial_num: 'SDP9988375879270' },
  { pin: 22128956, serial_num: 'SDP9988375879271' },
  { pin: 36864087, serial_num: 'SDP9988375879272' },
  { pin: 49280942, serial_num: 'SDP9988375879273' },
  { pin: 47421936, serial_num: 'SDP9988375879274' },
  { pin: 34639053, serial_num: 'SDP9988375879275' },
  { pin: 52842289, serial_num: 'SDP9988375879276' }
]

If serialNumLength.includePrefixLength === false,

it will add prefixCharacter length to the serialNumLength.length

Example

pinGen({
    serialNumLength : {
        length: 15,
        includePrefixLength: false
    },
    prefixCharacters: 'sdp',
    numberRequired: 7,
    pinLength: 8
})
.then(values => console.log(values))
.catch(err => console.log(err.message));

Which generates

[
  { pin: 62131779, serial_num: 'SDP5434814428618890' },
  { pin: 86781427, serial_num: 'SDP5434814428618891' },
  { pin: 57071838, serial_num: 'SDP5434814428618892' },
  { pin: 42043437, serial_num: 'SDP5434814428618893' },
  { pin: 82469489, serial_num: 'SDP5434814428618894' },
  { pin: 38335381, serial_num: 'SDP5434814428618895' },
  { pin: 97639287, serial_num: 'SDP5434814428618896' }
]

Using async await

(async () => {
    try {
        const values = await pinGen({
            pinLength: 12,
            prefixCharacters: 'sdp',
            serialNumLength: 8,
            numberRequired: 3
        })
        console.log(values);
    } catch (error) {
        console.log(error);
    }
})()

Which generates

[
  { pin: 203420843675, serial_num: 'SDP40700' },
  { pin: 603474470957, serial_num: 'SDP40701' },
  { pin: 725294039567, serial_num: 'SDP40702' }
]

Configuration Options

NOTE:

The options.serialNumLength should be at least four characters longer than the length of the options.prefixCharacters.

The default configuration is the equivalent of:

{
    pinLength: 12, 
    serialNumLength: {
        length: 15,
        includePrefixLength: false,
    }, 
    prefixCharacters: '', 
    numberRequired: 20
}

License

License under the ISC