# trimid

> A small unique id generator that is inspired by mongodb ObjectId with some modifications

Latest version **5.0.1** (published 2025-03-05) · ISC license · 0 weekly downloads

## Install

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

Provides the command `uniqid`.

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.0.1 |
| Published | 2025-03-05 |
| First published | 2021-06-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 46.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | JCloudYu |
| Maintainers | jcloudyu |
| Keywords | UniqueId, TrimId, ShortId |

## Links

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

## 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

- 5.0.1 (latest) — 2025-03-05
- 5.0.0 — 2025-01-11
- 4.1.0 — 2023-03-26
- 4.0.1 — 2022-09-25
- 4.0.0 — 2021-11-08
- 3.1.1 — 2021-08-21
- 3.1.0 — 2021-08-21
- 3.0.0 — 2021-07-22
- 2.1.0 — 2021-07-06
- 2.0.1 — 2021-07-06
- 2.0.0 — 2021-06-27
- 1.1.0 — 2021-06-27
- 1.0.0 — 2021-06-20

## README

# TrimId #
## Introduction ##
The trimid is an identifier generation system which provide mongodb's ObjectId system with following modifications.
1. 5 bytes to store timestamp value (which will result in the date of 36812-02-20 UTC)
2. 4 bytes to store machine id (which is a fnv1a32 hash of hostname by default)
3. 4 bytes to store process / subprocess / thread identifier (which is a fnv1a32 hash of the process/thread ids)
4. 3 bytes to store incrementing counter, which is randomly initialized

## Installation ##
Use the following command to install the module:
```bash
npm install trimid
```

## Usages ##
```js
// Grab trimid module
const TrimId = require('trimid');

// Generate new trimid
const new_id = TrimId.NEW;

// Convert id to a comparable string (base32hex format)
const string_id = new_id.toString(); //01i20mgo1b3toqjm7oa21erbis

// Restore an trimid instance from base32hex string
const restore_id = TrimId.from('01i20mgo1b3toqjm7oa21erbis');



// Use the following statment if you want to change machine id and session id
TrimId._base('some hostname', `new_session_id,${process.pid}.${process.ppid}`);

// The generated id's machine id and session id will be changed
const id_with_new_machine_id = Trim.NEW;
```

## Cli Usage ##
This module also provides a command that allow user generates a new uniqid string via CLI.
To use the command, install the module globally first.
```bash
npm install -g trimid
```

The use the following command to generate base32hex uniqid string
```bash
uniqid
```

Or if you want to generate binanry stream and perform custom encoding yourself.
```bash
uniqid --binary | base64
```

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