|
1 | 1 | # UUID Plus
|
2 | 2 |
|
3 | 3 | > **⚠️ FORK NOTICE: This repository is a fork of the [original dart-uuid](https://github.com/Daegalus/dart-uuid) by [Daegalus](https://github.com/Daegalus). maintained by Input Output Global, Inc. (IOG)**
|
4 |
| -
|
5 |
| - |
6 |
| -[](https://github.com/Daegalus/dart-uuid/actions) |
| 4 | +> |
| 5 | +> Original [README](https://github.com/Daegalus/dart-uuid/blob/main/README.md), [License](https://github.com/Daegalus/dart-uuid/blob/main/LICENSE) and [Documentation](https://daegalus.github.io/dart-uuid/index.html). |
7 | 6 |
|
8 | 7 | Simple, fast generation of [RFC4122](https://www.ietf.org/rfc/rfc4122.txt) and [RFC9562](https://www.rfc-editor.org/rfc/rfc9562.html) UUIDs.
|
9 | 8 |
|
10 | 9 | - [UUID Plus](#uuid-plus)
|
11 | 10 | - [Getting Started](#getting-started)
|
12 | 11 | - [Instructions](#instructions)
|
13 | 12 | - [Pubspec](#pubspec)
|
14 |
| - - [Documentation](#documentation) |
15 | 13 | - [Testing](#testing)
|
16 | 14 | - [Running Tests in Native Environment](#running-tests-in-native-environment)
|
17 | 15 | - [Running Tests in Browser Environment](#running-tests-in-browser-environment)
|
18 |
| - - [Performance Considerations](#performance-considerations) |
19 | 16 | - [Release notes](#release-notes)
|
20 | 17 | - [Attribution](#attribution)
|
21 | 18 |
|
22 | 19 | Features:
|
23 | 20 |
|
24 | 21 | * Generate RFC4122 version 1, version 4, or version 5 UUIDs
|
25 | 22 | * Supports RFC9562 version 6, version 7, and version 8
|
26 |
| -* Supported Platforms: |
27 |
| - * Web |
28 |
| - * Server |
29 |
| - * iOS |
30 |
| - * Android |
31 |
| - * Linux |
32 |
| - * MacOS |
33 |
| - * Windows (not tested) |
| 23 | +* Supported Platforms: Web, Server, iOS, Android, Linux, MacOS, Windows |
34 | 24 | * Cryptographically strong random number generation on all platforms
|
35 | 25 |
|
36 | 26 | ## Getting Started
|
@@ -63,12 +53,6 @@ uuid.v4(); // -> '110ec58a-a0f2-4ac4-8393-c866d813b8d1'
|
63 | 53 | uuid.v5(Uuid.NAMESPACE_URL, 'www.google.com'); // -> 'c74a196f-f19d-5ea9-bffd-a2742432fc9c'
|
64 | 54 | ```
|
65 | 55 |
|
66 |
| -## Documentation |
67 |
| - |
68 |
| -For documentation, please visit the [Documentation](https://daegalus.github.io/dart-uuid/index.html) page. Examples are included for most functions and classes. |
69 |
| - |
70 |
| -For more complex examples and other usages, please look at the [tests](test/uuid_test.dart). |
71 |
| - |
72 | 56 | ## Testing
|
73 | 57 |
|
74 | 58 | The library comes with a comprehensive test suite. Here's how to run the tests:
|
@@ -102,24 +86,7 @@ dart test test/uuid_test.dart test/other_test.dart
|
102 | 86 |
|
103 | 87 | ### Running Tests in Browser Environment
|
104 | 88 |
|
105 |
| -First, ensure you have the necessary dependencies in your `pubspec.yaml`: |
106 |
| - |
107 |
| -```yaml |
108 |
| -dev_dependencies: |
109 |
| - build_runner: ^2.4.8 |
110 |
| - build_web_compilers: ^4.0.9 |
111 |
| -``` |
112 |
| -
|
113 |
| -Create a `dart_test.yaml` file in your project root: |
114 |
| - |
115 |
| -```yaml |
116 |
| -# You can also specify [chrome, firefox] for multiple browsers |
117 |
| -platforms: [chrome] |
118 |
| -concurrency: 1 |
119 |
| -timeout: 2x |
120 |
| -``` |
121 |
| - |
122 |
| -Then run: |
| 89 | +To run all tests: |
123 | 90 |
|
124 | 91 | ```bash
|
125 | 92 | # Run all tests in Chrome
|
@@ -150,9 +117,6 @@ dart test test/uuid_test.dart --name="UUID v7 has mathematically sufficient rand
|
150 | 117 |
|
151 | 118 | This will open Chrome and pause execution, allowing you to use Chrome DevTools for debugging.
|
152 | 119 |
|
153 |
| -### Performance Considerations |
154 |
| - |
155 |
| -Some tests (particularly collision tests) may run millions of iterations. For browser testing, consider using the entropy-based validation tests instead of the brute-force collision tests, as they provide similar validation in a fraction of the time. |
156 | 120 |
|
157 | 121 | ## Release notes
|
158 | 122 |
|
|
0 commit comments