Browse Source

add readme

liuyuqi-dellpc 2 years ago
commit
a75fbda749
1 changed files with 34 additions and 0 deletions
  1. 34 0
      README.md

+ 34 - 0
README.md

@@ -0,0 +1,34 @@
+# faker
+
+Generate massive amounts of fake (but realistic) data for testing and development.
+
+## Develop
+
+```
+npm install --save-dev @faker-js/faker
+```
+
+
+```
+// ESM
+import { faker } from '@faker-js/faker';
+
+// CJS
+const { faker } = require('@faker-js/faker');
+
+export function createRandomUser(): User {
+  return {
+    userId: faker.datatype.uuid(),
+    username: faker.internet.userName(),
+    email: faker.internet.email(),
+    avatar: faker.image.avatar(),
+    password: faker.internet.password(),
+    birthdate: faker.date.birthdate(),
+    registeredAt: faker.date.past(),
+  };
+}
+
+export const USERS: User[] = faker.helpers.multiple(createRandomUser, {
+  count: 5,
+});
+```