guid/uuid in Typescript Node.js app

Question

I try to make a uuid (v 3.0.1) package work in Node/Typescript app, but I'm not sure what should I import and how to use it.

This is index.d.ts (from @types/uuid v 2.0.29):

declare namespace uuid {
    interface V1Options {
        node?: number[];
        clockseq?: number;
        msecs?: number | Date;
        nsecs?: number;
    }

    type V4Options = { random: number[] } | { rng: () => number[]; }

    interface UuidStatic {
        (options?: V4Options): string;
        (options: V4Options | null, buffer: number[], offset?: number): number[];
        (options: V4Options | null, buffer: Buffer, offset?: number): Buffer;

        v1(options?: V1Options): string;
        v1(options: V1Options | null, buffer: number[], offset?: number): number[];
        v1(options: V1Options | null, buffer: Buffer, offset?: number): Buffer;
        v4: UuidStatic;
        parse(id: string): number[];
        parse(id: string, buffer: number[], offset?: number): number[];
        parse(id: string, buffer: Buffer, offset?: number): Buffer;
        unparse(buffer: number[] | Buffer, offset?: number): string;
    }
}

declare const uuid: uuid.UuidStatic
export = uuid

I cant find exported class here.

For example index.d.ts from angular2-uuid looks like that:

export declare class UUID {
    constructor();
    static UUID(): string;
    private static pad4(num);
    private static random4();
}

And it's quite obvious to use:

let id = UUID.UUID();

So. How to use (import and call) uuid?

You have the wrong versions of types to the actual package. Make sure they match. — dwjohnston
– dwjohnston, Commented Aug 22, 2020 at 6:29

Michael Freidgeim · Accepted Answer · 2020-05-11 04:42:11Z

215

Yes, here is code from my project:

import { v4 as uuid } from 'uuid';
const id: string = uuid();

Note: to install definitions it is required to run

npm install --save-dev @types/uuid

edited May 11, 2020 at 4:42

Michael Freidgeim

28.8k17 gold badges164 silver badges181 bronze badges

answered May 8, 2017 at 1:27

Sergey Yarotskiy

4,8642 gold badges21 silver badges29 bronze badges

Sign up to request clarification or add additional context in comments.

4 Comments

tBlabs Over a year ago

or just import { v4 } from 'uuid'; That's solved my problem. Thanks!

Steve Over a year ago

This doesn't work. Error: 'v4' is not exported by node_modules/uuid/index.js

Sergey Yarotskiy Over a year ago

Just re-tested on the latest version of uuid module. Everything works as expected. I'll suggest you start another question on SO.

NLxDoDge Over a year ago

Another mention, that I had to restart my VSCode before the error goes away. No idea why but this is the correct solution.

Joe · Accepted Answer · 2017-05-07 23:41:27Z

13

Per the tests:

https://github.com/DefinitelyTyped/DefinitelyTyped/blob/354cec620daccfa0ad167ba046651fb5fef69e8a/types/uuid/uuid-tests.ts

import uuid = require('uuid');

let uuidv4: string = uuid.v4();

answered May 7, 2017 at 23:41

Joe

42.9k20 gold badges108 silver badges129 bronze badges

2 Comments

tBlabs Over a year ago

That's works! Thanks, but... Is there any way to use import { } from "" typescript style?

eVolve Over a year ago

This works best for Typescript. Top answer was complaining about any warnings from linter

Mild Fuzz · Accepted Answer · 2022-11-24 17:10:46Z

12

I used uuid for my project in the following order

Must be installed

npm i --save-dev @types/uuid
npm install uuid

Using the uuid package

import { v4 as uuidv4 } from 'uuid';
const myuuid = uuidv4();
console.log('Your UUID is: 'myuuid);

edited Nov 24, 2022 at 17:10

Mild Fuzz

31.3k34 gold badges106 silver badges152 bronze badges

answered Mar 9, 2022 at 7:15

user15630604

Comments

Steve Gula · Accepted Answer · 2019-01-12 01:19:02Z

10

import * as uuid from "uuid";
const id: string = uuid.v4();

answered Jan 12, 2019 at 1:19

Steve Gula

2043 silver badges8 bronze badges

Comments

GaryO · Accepted Answer · 2019-04-19 20:28:36Z

6

This also works for me:

import uuidv4 from 'uuid/v4'

this.projectId = uuidv4()

answered Apr 19, 2019 at 20:28

GaryO

6,4381 gold badge46 silver badges75 bronze badges

Comments

Michał J. Gąsior · Accepted Answer · 2023-05-18 09:42:35Z

Quoting Geshan Manandhar from his blogpost 3 efficient ways to generate UUID in Node.js you can use a built in Nodejs package:

Node.js UUID with Crypto module

The crypto module was added from Node.js 14.17.0. It provides cryptographic functionally for multiple methods and algorithms like OpenSSL’s hash, HMAC, cipher. It also provides a method called randomUUID to generate UUID in Node.js without instaling any new NPM module.

The method takes an options object that can have a disableEntropyCache boolean value that defaults to values. When it is set to true it doesn’t use the cache on the UUID generation. Below is a code example of Cryto module’s randomUUID function:

const crypto = require('crypto');
console.log(crypto.randomUUID());

You can also use it this way:

import { randomUUID } from 'crypto';
console.log(randomUUID());

anoja madusanka · Accepted Answer · 2023-09-06 15:26:36Z

2

firstly install these two packages

npm i --save-dev @types/uuid 
npm install uuid

Then by using uuid package, you can easily do your job.

import { v4 as uuidv4 } from 'uuid';
const myuuid = uuidv4();
console.log('Your UUID is: 'myuuid);

answered Sep 6, 2023 at 15:26

anoja madusanka

1491 silver badge5 bronze badges

Comments

Amir Hajitabar · Accepted Answer · 2023-10-22 09:55:12Z

2

import { v4 as uuid } from 'uuid';

if use TypeScript should install definitions:

npm i --save-dev @types/uuid

answered Oct 22, 2023 at 9:55

Amir Hajitabar

233 bronze badges

1 Comment

Community Over a year ago

Your answer could be improved with additional supporting information. Please edit to add further details, such as citations or documentation, so that others can confirm that your answer is correct. You can find more information on how to write good answers in the help center.

Stephen Patton · Accepted Answer · 2024-03-08 13:15:18Z

2

Even faster is to just use the builtin browser function:

      myuuid = self.crypto.randomUUID()

See Mozilla's Crypto: randomUUID() method

answered Mar 8, 2024 at 13:15

Stephen Patton

971 silver badge8 bronze badges

Collectives™ on Stack Overflow

guid/uuid in Typescript Node.js app

9 Answers 9

4 Comments

2 Comments

Comments

Comments

Comments

Comments

Comments

1 Comment

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

9 Answers 9

4 Comments

2 Comments

Comments

Comments

Comments

Comments

Comments

1 Comment

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related