# guid

> A Guid generator and validator.

Latest version **0.0.12** (published 2013-12-20) · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

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

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.12 |
| Published | 2013-12-20 |
| First published | 2011-07-13 |
| Weekly downloads | 0 |
| TypeScript types | separate (@types/guid) |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 97 |
| Author | Dan Dean |
| Maintainers | dandean |

## Links

- npm: https://www.npmjs.com/package/guid
- Repository: https://github.com/dandean/guid
- Issues: https://github.com/dandean/guid/issues
- npm.io page: https://npm.io/package/guid

## Recent versions

- 0.0.12 (latest) — 2013-12-20
- 0.0.11 — 2013-11-20
- 0.0.10 — 2011-07-13
- 0.0.9 — 2011-07-13
- 0.0.8 — 2011-07-13
- 0.0.5 — 2011-07-13
- 0.0.6 — 2011-07-13
- 0.0.7 — 2011-07-13

## README

# Guid lets you generate and validate unique identifiers.

[![browser support](https://ci.testling.com/tommydudebreaux/guid.png)](https://ci.testling.com/tommydudebreaux/guid)

In its simplest form, Guid lets you generate raw GUID formatted strings:

    Guid.raw();
    // -> '6fdf6ffc-ed77-94fa-407e-a7b86ed9e59d'

Let's generate a new Guid instance.

    var guid = Guid.create();

We've now got an object which we can work with programmatically. Lets check the
validity of our Guid using the built-in validator:

    Guid.isGuid(guid);
    // -> true
    
    Guid.value;
    // -> '6fdf6ffc-ed77-94fa-407e-a7b86ed9e59d'

A handy bit of functionality is that its `toString` method returns the string
value, so you can do handy things like this:

    var itemUrl = "http://whatever.com/items/" + guid;
    // -> 'http://whatever.com/items/6fdf6ffc-ed77-94fa-407e-a7b86ed9e59d'
    
If you need a placeholder Guid, or a value to represent a non-GUID, use the
static `EMPTY` property:

    Guid.EMPTY;
    // -> '00000000-0000-0000-0000-000000000000'

Once you have a `Guid` object, you can't change its value (thanks ES5!):

    guid.value = "go suck it, guid!"
    guid.value;
    // -> '6fdf6ffc-ed77-94fa-407e-a7b86ed9e59d'

To instantiate an Guid object using an existing GUID string, use the constructor:

    var guid = new Guid('6fdf6ffc-ed77-94fa-407e-a7b86ed9e59d');

You can check the equality of two different Guid objects using the `equals`
instance method.

Compare a Guid object to a GUID string:

    guid.equals('6fdf6ffc-ed77-94fa-407e-a7b86ed9e59d');
    // -> true

Compare two Guid objects:
    
    guid.equals(new Guid('6fdf6ffc-ed77-94fa-407e-a7b86ed9e59d'));
    // -> true

## Installation

You can use npm to install guid: `npm install guid`


## But what if I need a UUID, not a GUID?

There's also a [Uuid](https://github.com/dandean/uuid-lib) library which has the
**exact** same functionality, but for UUID's:
[https://github.com/dandean/uuid-lib](https://github.com/dandean/uuid-lib)

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