@grkndev/snowflakeid/README.md

A simple Snowflake ID generator for JavaScript and TypeScript

# Snowflake ID Generator

A simple and customizable Snowflake ID generator for JavaScript and TypeScript projects, now with an additional random ID generation feature.

## Installation

```bash
npm install @grkndev/snowflakeid
```

## Usage

### JavaScript

```javascript
const { generateSnowflakeId, parseSnowflakeId, randomId, uuid } = require('@grkndev/snowflakeid');

// Generate a Snowflake ID with default options
const id = generateSnowflakeId();
console.log(id);
//=> '79796401721711616'

// Generate a Snowflake ID with custom options
const customId = generateSnowflakeId({ nodeId: 5, epoch: 1609459200000 });
console.log(customId);

// Parse a Snowflake ID
const parsedId = parseSnowflakeId(id);
console.log(parsedId);

// Generate a random ID
const randomID = randomId();
console.log(randomID);
//=> '283946'

// Generate a random ID with custom options
const customRandomID = randomId(8, { useChars: true, useNumbers: true });
console.log(customRandomID);
//=> 'a3Bf9x2Z'

// Generate a random UUID with default options
const uuId = uuid();
console.log(uuId);
//=> 'aBcD1234-EfGh5678-iJkL9012-MnOp3456'

// Generate a random UUID with custom split count
const customUuId = uuid(6);
console.log(customUuId);
//=> 'aBcD1234-EfGh5678-iJkL9012-MnOp3456-QrSt7890-UvWx1234'

```

### TypeScript

```typescript
import { generateSnowflakeId, parseSnowflakeId, SnowflakeOptions, randomId, RandomIdOptions, uuid } from '@grkndev/snowflakeid';

// Generate a Snowflake ID with default options
const id = generateSnowflakeId();
console.log(id);

// Generate a Snowflake ID with custom options
const options: SnowflakeOptions = { nodeId: 5, epoch: 1609459200000 };
const customId = generateSnowflakeId(options);
console.log(customId);

// Parse a Snowflake ID
const parsedId = parseSnowflakeId(id);
console.log(parsedId);

// Generate a random ID with default options
const randomID = randomId();
console.log(randomID);

// Generate a random ID with custom options
const randomOptions: RandomIdOptions = { useChars: true, useNumbers: true };
const customRandomID = randomId(8, randomOptions);
console.log(customRandomID);

// Generate a random UUID
const uuId = uuid();
console.log(uuId);

// Generate a random UUID with custom split count
const customUuId = uuid(6);
console.log(customUuId);
```

## API

### generateSnowflakeId(options?: SnowflakeOptions): string

Generates a Snowflake ID.

Options:
- `epoch` (optional): Custom epoch timestamp (in milliseconds since Unix epoch). Default is 1609459200000 (2021-01-01T00:00:00Z).
- `nodeId` (optional): Node ID for distributed systems (0-1023). Default is 1.
- `sequence` (optional): Initial sequence number (0-4095).

Returns a string representation of the generated Snowflake ID.

### parseSnowflakeId(id: string, epoch?: number): { timestamp: Date, nodeId: number, sequence: number }

Parses a Snowflake ID into its component parts.

Parameters:
- `id`: The Snowflake ID to parse.
- `epoch` (optional): The epoch used in ID generation. Default is 1609459200000 (2021-01-01T00:00:00Z).

Returns an object containing the parsed components of the Snowflake ID:
- `timestamp`: Date object representing the timestamp of ID generation.
- `nodeId`: The node ID used in ID generation.
- `sequence`: The sequence number used in ID generation.

### randomId(length?: number, options?: RandomIdOptions): string

Generates a random ID.

Parameters:
- `length` (optional): The length of the ID to generate. Default is 6.
- `options` (optional): An object with the following properties:
  - `useChars` (optional): Whether to use alphabetic characters. Default is false.
  - `useNumbers` (optional): Whether to use numeric characters. Default is true.

Returns a string representation of the generated random ID.

### uuid(split?: number): string

Generates a pseudo-UUID string using random alphanumeric characters.

> **Note:** This is NOT a standard UUID (RFC 4122). It generates a random alphanumeric string split into segments for readability. For cryptographically secure UUIDs, use `crypto.randomUUID()` instead.

Parameters:
- `split` (optional): The number of 8-character segments to generate. Default is 4.

Returns a string with segments separated by hyphens (e.g., "aBcD1234-EfGh5678-iJkL9012-MnOp3456").

## Error Handling

The `generateSnowflakeId` function may throw errors in the following cases:
- If the provided `nodeId` is less than 0 or greater than 1023.
- If the provided `epoch` is a negative number or a future timestamp.
- If the system clock moves backwards.

The `randomId` function may throw errors in the following cases:
- If the provided `length` is less than 1.
- If neither `useChars` nor `useNumbers` is set to true in the options.

The `uuid` function may throw an error if the provided `split` is less than 1.

## Update Notes

For a detailed list of changes, improvements, and bug fixes in each version, please see the [UpdateNotes.md](./UpdateNotes.md) file.

## License

MIT