README.md

gp-uid

Description

This repository provides a powerful ground place unique identifier generator.

Install

yarn add @tictactrip/gp-uid

How to use it?

import { Generator } from "@tictactrip/gp-uid";

const generator = new Generator();

const gpuid = generator.gpuid({
        name: 'Paris, Île-de-France, France',
        latitude: 49.00443,
        longitude: 2.51703,
        countryCode: 'fr',
        type: 'cluster',
      });

console.log(gpuid);

Output:

[
    {
        id: 'c|FRparis___@u09yc',
        countryCode: 'fr',
        latitude: 49.00443,
        longitude: 2.51703,
        name: 'Paris, Île-de-France, France',
        type: 'cluster'
    }
]

Scripts

Run using yarn run <script> command.

clean       - Remove temporarily folders.
build       - Compile source files.
build:watch - Interactive watch mode, compile sources on change.
lint        - Lint source files.
lint:fix    - Fix lint source files.
test        - Runs all tests with coverage.
test:watch  - Interactive watch mode, runs tests on change.

License

GPL-3.0 © Tictactrip