# uniki

> generate a unique key given any length of string (specific length hash)

Latest version **1.0.3** (published 2015-08-21) · GPL-2.0 license · 0 weekly downloads

## Install

```sh
npm install uniki
pnpm add uniki
yarn add uniki
bun add uniki
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2015-08-21 |
| First published | 2015-08-20 |
| Weekly downloads | 0 |
| License | GPL-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.10 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | @nelsonic |
| Maintainers | nelsonic |
| Keywords | unique, key, hash |

## Links

- npm: https://www.npmjs.com/package/uniki
- Repository: https://github.com/nelsonic/uniki
- Homepage: https://github.com/nelsonic/uniki#readme
- Issues: https://github.com/nelsonic/uniki/issues
- npm.io page: https://npm.io/package/uniki

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2015-08-21
- 1.0.2 — 2015-08-20
- 1.0.1 — 2015-08-20
- 1.0.0 — 2015-08-20

## README

# uniki

[![Build Status](https://travis-ci.org/nelsonic/uniki.svg)](https://travis-ci.org/nelsonic/uniki)
[![Code Climate](https://codeclimate.com/github/nelsonic/uniki/badges/gpa.svg)](https://codeclimate.com/github/nelsonic/uniki)
[![Test Coverage](https://codeclimate.com/github/nelsonic/uniki/badges/coverage.svg)](https://codeclimate.com/github/nelsonic/uniki/coverage)
[![Dependency Status](https://david-dm.org/nelsonic/uniki.svg)](https://david-dm.org/nelsonic/uniki)
[![devDependency Status](https://david-dm.org/nelsonic/uniki/dev-status.svg)](https://david-dm.org/nelsonic/uniki#info=devDependencies)
[![Node.js Version][node-version-image]][node-version-url]
[![NPM Version][npm-image]][npm-url]

![matrix-reloaded-keymaster](http://i.imgur.com/lRpBPXI.jpg)

There are ***many use cases*** for unique keys.

Our ["***itch***"](https://gettingreal.37signals.com/ch02_Whats_Your_Problem.php)
is minimizing the bytes occupied in our database by frequent strings.

Like a *Hash* but shorter.

## Usage

### Install from NPM

```sh
npm install uniki ---save
```

### Use it in your code/script

```js
var uniki = require('uniki');
console.log(uniki('hello world')); // >> MJ7MSJwS    (ALWAYS The Same!)
```

That's all there is to it.
Enjoy!

# tl;dr

## Hold On, This Sounds Familiar ...

*If* this ***looks familiar***, its because it is!!  
We have built a virtually identical module: https://www.npmjs.com/package/perma  
The key (*see what we did there...?*) ***difference is*** that we are not excluding any characters from the population because no *humans* are
going to be typing these keys, they are used exclusively by
our database as keys.  
Also similar is https://www.npmjs.com/package/aguid
but ***uniki*** we ***don't want*** our **keys** to be ***36 characters*** **long**!

[node-version-image]: https://img.shields.io/node/v/uniki.svg?style=flat
[node-version-url]: http://nodejs.org/download/
[npm-image]: https://img.shields.io/npm/v/uniki.svg?style=flat
[npm-url]: https://npmjs.org/package/uniki

---
_Source: https://npm.io/package/uniki · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._