Skip to content

surpri6e/random-key

Repository files navigation

npm version install size npm downloads

RKey

Library for create random unique key. You can use it in ECMAScript and CommonJS projects.

All structures

TComponentsOfKey

export type TComponentsOfKey = 'numbers' | 'letters' | 'all';

getRandomKey

type TGetRandomKeySignature = (length: number, components: TComponentsOfKey) => string;

/**
    Generate new unique key
    @param {number} length length of your key
    @param {TComponentsOfKey} components additional information about your key

    @returns {string} unique key
*/
export const getRandomKey: TGetRandomKeySignature = (length, components) => {...}