js-guid

js-guid is a javascript library that lets you generate and manage unique identifiers GUIDs written with TypeScript.

Quick start

1. Install

1npm install js-guid
2
3# or
4
5yarn add js-guid

2. Library APIs

In order to start using the library use the following statement:

1import { Guid } from 'js-guid';
2
3// or
4
5const { Guid } = require('js-guid');

API	Description
Guid.EMPTY	(static) The Empty Guid string (all zeros).
Guid.newGuid()	(static) Generate a new v4 Guid and return a new instance of the Guid.
Guid.isValid(value)	(static) Checks if the given value is a valid GUID.
Guid.parse(value)	(static) Parse the given value into the opposite type.
new Guid(value?)	Instantiate a new Guid object.
guid.toString()	Returns the string format of the Guid.
guid.toByteArray()	Returns the Uint8Array of the Guid.
guid.equals(value)	Compare the Given value with the current Guid.
guid.isEmpty()	Return {True} if the Guid holds an empty value, False otherwise.

API details

Guid.EMPTY

The Empty Guid string (all zeros).

example

1import { Guid } from 'js-guid';
2
3console.log(Guid.Empty);
4
5// Output
6// ⇨ '00000000-0000-0000-0000-000000000000'

Guid.newGuid()

Generate a new v4 Guid and return a new instance of the Guid.

Example

1import { Guid } from 'js-guid';
2
3console.log(Guid.newGuid());
4
5// Output
6// ⇨ '77eb3969-19fd-4223-907a-5749669f1178'

Guid.isValid(value)

Checks if the given value is a valid GUID.

Key	Description
value	A valid Guid String or Uint8Array.
returns	true if valid, false otherwise.
throws	Error if value is not a valid Guid.

Example

1import { Guid } from 'js-guid';
2
3console.log(Guid.isValid('77eb3969-19fd-4223-907a-5749669f1178'));
4
5console.log(Guid.isValid(new Uint8Array([
6  105, 57, 235, 119,
7  253, 25, 35, 66,
8  144, 122, 87, 73,
9  102, 159, 17, 120,
10]));
11
12// Output
13// ⇨ true
14// ⇨ true

Guid.parse(value)

Parse the given value into the opposite type.

Note : if value is string the function return a {Uint8Array of 16 elements}, otherwise it return a {string} if the value is a Uint8Array.

Key	Description
value	A valid Guid String or Uint8Array.
returns	Uint8Array(16) if value is string. Or, returns string if value is Uint8Array(16).
throws	Error if value is not a valid Guid, or type is not supported.

Example

1import { Guid } from 'js-guid';
2
3console.log(Guid.parse('77eb3969-19fd-4223-907a-5749669f1178'));
4
5// Output
6// ⇨ [
7//    105, 57, 235, 119,
8//    253, 25, 35, 66,
9//    144, 122, 87, 73,
10//    102, 159, 17, 120,
11//  ]
12
13console.log(Guid.isValid(new Uint8Array([
14  105, 57, 235, 119,
15  253, 25, 35, 66,
16  144, 122, 87, 73,
17  102, 159, 17, 120,
18]));
19
20// Output
21// ⇨ '77eb3969-19fd-4223-907a-5749669f1178'

new Guid(value?)

Create a new instance of the Guid with the given value, or generate a new Guid if no value was given.

Key	Description
value	A valid Guid String or Uint8Array.
returns	new Guid instance.
throws	Error if value is not a valid Guid, or type is not supported.

Example

1import { Guid } from 'js-guid';
2
3let guid = new Guid();
4console.log(guid.toString());
5
6guid = new Guid('77eb3969-19fd-4223-907a-5749669f1178');
7console.log(guid.toString());
8
9guid = new Guid(
10  new Uint8Array([
11    105, 57, 235, 119, 253, 25, 35, 66, 144, 122, 87, 73, 102, 159, 17, 120,
12  ]),
13);
14console.log(guid.toString());
15
16// Output
17// ⇨ '77eb3969-19fd-4223-907a-5749669f1178'
18// ⇨ '77eb3969-19fd-4223-907a-5749669f1178'
19// ⇨ '77eb3969-19fd-4223-907a-5749669f1178'

Guid.toString()

Returns the string format of the Guid.

Key	Description
returns	string value of the Guid instance.

Example

1import { Guid } from 'js-guid';
2
3const guid = new Guid();
4console.log(guid.toString());
5
6// Output
7// ⇨ '77eb3969-19fd-4223-907a-5749669f1178'

Guid.toByteArray()

Returns the Uint8Array of the Guid.

Key	Description
returns	Uint8Array(16) value of the Guid instance.

Example

1import { Guid } from 'js-guid';
2
3const guid = new Guid();
4console.log(guid.toByteArray());
5
6// Output
7// ⇨ [
8//    105, 57, 235, 119,
9//    253, 25, 35, 66,
10//    144, 122, 87, 73,
11//    102, 159, 17, 120,
12//  ]

Guid.equals(value)

Compare the Given value with the current Guid.

Key	Description
value	A valid Guid String, Uint8Array or Guid object.
returns	true if equals, false otherwise.
throws	Error if value is not a valid Guid. or type not spported.

Example

1import { Guid } from 'js-guid';
2
3const guid = new Guid('77eb3969-19fd-4223-907a-5749669f1178');
4const guid2 = new Guid();
5
6console.log(guid.equals(guid2));
7console.log(guid.equals('77eb3969-19fd-4223-907a-5749669f1178'));
8console.log(
9  guid.equals(
10    new Uint8Array([
11      105, 57, 235, 119, 253, 25, 35, 66, 144, 122, 87, 73, 102, 159, 17, 120,
12    ]),
13  ),
14);
15
16// Output
17// ⇨ false
18// ⇨ true
19// ⇨ true

Guid.isEmpty()

Return {True} if the Guid holds an empty value, False otherwise.

Key	Description
returns	true if Guid equals Guid.Empty, false otherwise.

Example

1import { Guid } from 'js-guid';
2
3let guid = new Guid();
4console.log(guid.isEmpty());
5
6guid = new Guid(Guid.Empty);
7console.log(guid.isEmpty());
8
9// Output
10// ⇨ false
11// ⇨ true