https://github.com/surpri6e/random-key

Library for create random key
https://github.com/surpri6e/random-key

random random-generation string typescript unique-key

Last synced: 3 months ago
JSON representation

Library for create random key

• Host: GitHub
• URL: https://github.com/surpri6e/random-key
• Owner: surpri6e
• License: mit
• Created: 2024-04-06T14:24:55.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-12T21:06:30.000Z (about 1 year ago)
• Last Synced: 2024-05-10T09:12:47.364Z (about 1 year ago)
• Topics: random, random-generation, string, typescript, unique-key
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/rkey
• Size: 50.8 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![npm version](https://img.shields.io/npm/v/rkey.svg?style=flat-square)](https://www.npmjs.org/package/rkey)

[![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=rkey&query=$.install.pretty&label=install%20size&style=flat-square)](https://packagephobia.now.sh/result?p=rkey)

[![npm downloads](https://img.shields.io/npm/dy/rkey.svg?style=flat-square)](https://npm-stat.com/charts.html?package=rkey)

# RKey

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

## All structures

### TComponentsOfKey

```ts

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

```

### getRandomKey

```ts

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) => {...}

```