https://github.com/chanmyaemaung/chanid

CHANID is a compact and robust utility for generating unique identifiers in JavaScript and TypeScript.
https://github.com/chanmyaemaung/chanid

chanid js-library npm-package typescript-library vanilla-js

Last synced: about 1 month ago
JSON representation

CHANID is a compact and robust utility for generating unique identifiers in JavaScript and TypeScript.

• Host: GitHub
• URL: https://github.com/chanmyaemaung/chanid
• Owner: chanmyaemaung
• License: isc
• Created: 2023-12-02T13:33:48.000Z (about 1 year ago)
• Default Branch: latest
• Last Pushed: 2023-12-25T16:14:51.000Z (12 months ago)
• Last Synced: 2023-12-26T17:07:33.487Z (12 months ago)
• Topics: chanid, js-library, npm-package, typescript-library, vanilla-js
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/chanid
• Size: 63.5 KB
• Stars: 2
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# CHANID (Chan Lay ID)

[![npm version](https://badge.fury.io/js/chanid.svg)](https://www.npmjs.com/package/chanid)

![License](https://img.shields.io/github/license/chanmyaemaung/chanid)

[![npm downloads](https://img.shields.io/npm/dt/chanid.svg)](https://www.npmjs.com/package/chanid)

[![Bundle Size](https://img.shields.io/bundlephobia/min/chanid)](https://bundlephobia.com/result?p=chanid)

[![TypeScript](https://img.shields.io/badge/-TypeScript-blue)](https://www.typescriptlang.org/)

[![Code Style: Prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)](https://prettier.io/)

[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](https://github.com/chanmyaemaung/chanid/issues)

CHANID is a minimalistic and efficient utility for generating unique identifiers in JavaScript and TypeScript. It can be seamlessly integrated into your projects, whether you're working with vanilla JavaScript or taking advantage of TypeScript's static typing.

## Table of Contents

- [CHANID (Chan Lay ID)](#chanid-chan-lay-id)

  - [Table of Contents](#table-of-contents)

  - [Installation](#installation)

  - [Usage](#usage)

  - [Features](#features)

  - [CDN Usage](#cdn-usage)

  - [Contributing](#contributing)

  - [License](#license)

## Installation

You can install CHANID via npm:

```bash

npm install chanid

```

## Usage

CHANID is very easy to use. Simply import the module and call the function to generate a unique identifier.

```js

// Import the CHANID function from the module

const chanid = require('chanid');

// Generate a unique identifier

const uniqueID = chanid();

console.log(uniqueID);

```

Note: If you are using TypeScript, you can use the import statement instead:

```js

// Import the CHANID function from the module

import chanid from 'chanid';

// Generate a unique identifier

const uniqueID = chanid();

console.log(uniqueID);

```

## Features

Generates unique identifiers based on the UUID format.

Works in both JavaScript and TypeScript environments.

## CDN Usage

You can also include CHANID directly in your HTML file using a CDN:

```html

  import chanid from 'https://cdn.jsdelivr.net/npm/[email protected]/dist/chanid.min.mjs';

  const uniqueID = chanid();

  console.log(uniqueID);

```

## Contributing

If you would like to contribute to CHANID, feel free to submit a pull request or open an issue.

## License

This project is licensed under the ISC License - see the `LICENSE.md` file for details.