Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cdimascio authored May 16, 2020
1 parent 45efce8 commit d93983c
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@ The mode is set **globally**. Here is how to set it:
const mUUID = MUUID.mode('relaxed'); // use relaxed mode
```

Currently, mode _**only**_ impacts how `JSON.stringify(mUUID)` represents a UUID:

e.g. `JSON.stringy(mUUID.v1())` outputs the following:

```shell
"DEol4JenEeqVKusA+dzMMA==" // canonical mode
"1ac34980-97a7-11ea-8bab-b5327b548666" // relaxed mode
```

## Formatting

UUIDs may be formatted using the following options:
Expand Down

0 comments on commit d93983c

Please sign in to comment.