From 7fb2ba1b68d3bf156b18f32f32e521db2826f971 Mon Sep 17 00:00:00 2001
From: Joseph Mearman <joseph@mearman.co.uk>
Date: Mon, 7 Dec 2020 10:38:03 +0000
Subject: [PATCH] docs: add examples of per-version validation

---
 README.md    | 17 +++++++++++++++++
 README_js.md | 17 +++++++++++++++++
 2 files changed, 34 insertions(+)

diff --git a/README.md b/README.md
index 11b7cc7e..ed27e576 100644
--- a/README.md
+++ b/README.md
@@ -296,6 +296,23 @@ uuidValidate('not a UUID'); // ⇨ false
 uuidValidate('6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b'); // ⇨ true
 ```
 
+Using `validate` and `version` together it is possible to do per-version validation, e.g. validate for only v4 UUIds.
+
+```javascript
+import { version as uuidVersion } from 'uuid';
+import { validate as uuidValidate } from 'uuid';
+
+function uuidValidateV4(uuid) {
+  return uuidValidate(uuid) && uuidVersion(uuid) === 4;
+}
+
+const v1Uuid = 'd9428888-122b-11e1-b85c-61cd3cbb3210';
+const v4Uuid = '109156be-c4fb-41ea-b1b4-efe1671c5836';
+
+uuidValidateV4(v4Uuid); // ⇨ true
+uuidValidateV4(v1Uuid); // ⇨ false
+```
+
 ### uuid.version(str)
 
 Detect RFC version of a UUID
diff --git a/README_js.md b/README_js.md
index a2769a22..0e858a47 100644
--- a/README_js.md
+++ b/README_js.md
@@ -302,6 +302,23 @@ uuidValidate('not a UUID'); // RESULT
 uuidValidate('6ec0bd7f-11c0-43da-975e-2a8ad9ebae0b'); // RESULT
 ```
 
+Using `validate` and `version` together it is possible to do per-version validation, e.g. validate for only v4 UUIds.
+
+```javascript --run
+import { version as uuidVersion } from 'uuid';
+import { validate as uuidValidate } from 'uuid';
+
+function uuidValidateV4(uuid) {
+  return uuidValidate(uuid) && uuidVersion(uuid) === 4;
+}
+
+const v1Uuid = 'd9428888-122b-11e1-b85c-61cd3cbb3210';
+const v4Uuid = '109156be-c4fb-41ea-b1b4-efe1671c5836';
+
+uuidValidateV4(v4Uuid); // RESULT
+uuidValidateV4(v1Uuid); // RESULT
+```
+
 ### uuid.version(str)
 
 Detect RFC version of a UUID