data-faker-plus 0.0.8 → 0.1.0

package/README.md

@@ -1,6 +1,6 @@
 # Getting Started
 
-[Official Website](https://df-docs-b8ktmo4q6-bloom-lmh.vercel.app/)
+[Official Website](https://df-docs-seven.vercel.app/)
 [中文官网](https://datafaker-9j23z0sk.maozi.io/)
 
 ## Introduction
@@ -580,3 +580,55 @@ const userDatas = fakeData(userModel, {
   },
 });
 ```
+
+## Data Iterator
+
+Data Iterators are designed to help you sequentially use data from a collection when generating data, simplifying your code writing. For example, consider the following scenario:
+
+> Need to generate 3 user data entries, each with a different hobby.
+
+If written using traditional `faker.js`, the code would look like this:
+
+```javascript{2,6}
+let hobbyArr = ['basketball', 'soccer', 'table tennis'];
+let index = 0;
+const userModel = defineModel('user', {
+  id: 'string.uuid',
+  hobby: () => {
+    return hobbyArr[index++];
+  },
+});
+console.log(fakeData(userModel, 4));
+```
+
+The generated data would be as follows:
+
+```json
+[
+  { "id": "d16e7a49-5e7a-40a0-97e7-68693ffa7268", "hobby": "basketball" },
+  { "id": "268a6a63-5eee-4668-a166-d1b9f8bcf510", "hobby": "soccer" },
+  { "id": "2ed907c6-0cdf-40bd-95cf-6aaf3ebe5d1c", "hobby": "table tennis" },
+  { "id": "7d9b0df7-7fd3-401d-a7a9-59759a0948b4", "hobby": undefined }
+]
+```
+
+As you can see, you need to manually maintain the `index` variable, which is inconvenient and prone to confusion with other `index` variables. Therefore, `DataFaker` takes this into account. You only need to obtain an iterator to sequentially use data from the collection, as shown below:
+
+```javascript {2,6}
+let hobbyArr = ['basketball', 'soccer', 'table tennis'];
+const iterator = IteratorFactory.getIterator(hobbyArr);
+const userModel = defineModel('user', {
+  id: 'string.uuid',
+  hobby: () => {
+    return iterator.next().value;
+  },
+});
+console.log(fakeData(userModel, 4));
+```
+
+`DataFaker` provides four types of data iterators, which can be obtained from the iterator factory `IteratorFactory`:
+
+- Forward Iterator: `IteratorFactory.getIterator()`
+- Reverse Iterator: `IteratorFactory.getReverseIterator()`
+- Loop Forward Iterator: `IteratorFactory.getLoopIterator()`
+- Loop Reverse Iterator: `IteratorFactory.getLoopReverseIterator()`