Skip to content

Commit df0f5d1

Browse files
authored
docs: add examples of per-version validation (#543)
1 parent 334ef62 commit df0f5d1

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -296,6 +296,23 @@ uuidValidate('not a UUID'); // ⇨ false
296296
uuidValidate('6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b'); // ⇨ true
297297
```
298298

299+
Using `validate` and `version` together it is possible to do per-version validation, e.g. validate for only v4 UUIds.
300+
301+
```javascript
302+
import { version as uuidVersion } from 'uuid';
303+
import { validate as uuidValidate } from 'uuid';
304+
305+
function uuidValidateV4(uuid) {
306+
return uuidValidate(uuid) && uuidVersion(uuid) === 4;
307+
}
308+
309+
const v1Uuid = 'd9428888-122b-11e1-b85c-61cd3cbb3210';
310+
const v4Uuid = '109156be-c4fb-41ea-b1b4-efe1671c5836';
311+
312+
uuidValidateV4(v4Uuid); // ⇨ true
313+
uuidValidateV4(v1Uuid); // ⇨ false
314+
```
315+
299316
### uuid.version(str)
300317

301318
Detect RFC version of a UUID

README_js.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,23 @@ uuidValidate('not a UUID'); // RESULT
302302
uuidValidate('6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b'); // RESULT
303303
```
304304

305+
Using `validate` and `version` together it is possible to do per-version validation, e.g. validate for only v4 UUIds.
306+
307+
```javascript --run
308+
import { version as uuidVersion } from 'uuid';
309+
import { validate as uuidValidate } from 'uuid';
310+
311+
function uuidValidateV4(uuid) {
312+
return uuidValidate(uuid) && uuidVersion(uuid) === 4;
313+
}
314+
315+
const v1Uuid = 'd9428888-122b-11e1-b85c-61cd3cbb3210';
316+
const v4Uuid = '109156be-c4fb-41ea-b1b4-efe1671c5836';
317+
318+
uuidValidateV4(v4Uuid); // RESULT
319+
uuidValidateV4(v1Uuid); // RESULT
320+
```
321+
305322
### uuid.version(str)
306323

307324
Detect RFC version of a UUID

0 commit comments

Comments
 (0)