Merge pull request #22 from mizdra/build-list

`.buildList()`

Author: mizdra

src/factory.ts

@@ -35,6 +35,13 @@ export interface TypeFactoryInterface<
   build<const T extends InputFieldsResolver<Type & TransientFields>>(
     inputFieldsResolver: T,
   ): Promise<Pick<Merge<ResolvedFields<_DefaultFieldsResolver>, ResolvedFields<T>>, keyof Type>>;
+  buildList(
+    count: number,
+  ): Promise<Pick<Merge<ResolvedFields<_DefaultFieldsResolver>, ResolvedFields<{}>>, keyof Type>[]>;
+  buildList<const T extends InputFieldsResolver<Type & TransientFields>>(
+    count: number,
+    inputFieldsResolver: T,
+  ): Promise<Pick<Merge<ResolvedFields<_DefaultFieldsResolver>, ResolvedFields<T>>, keyof Type>[]>;
   use<T extends keyof _Traits>(
     traitName: T,
   ): TypeFactoryInterface<Type, TransientFields, Merge<_DefaultFieldsResolver, _Traits[T]['defaultFields']>, _Traits>;
@@ -67,6 +74,22 @@ export function defineTypeFactoryInternal<
         inputFieldsResolver ?? ({} as T),
       );
     },
+    async buildList<const T extends InputFieldsResolver<Type & TransientFields>>(
+      count: number,
+      inputFieldsResolver?: T,
+    ): Promise<Pick<Merge<ResolvedFields<_DefaultFieldsResolver>, ResolvedFields<T>>, keyof Type>[]> {
+      const array: Pick<Merge<ResolvedFields<_DefaultFieldsResolver>, ResolvedFields<T>>, keyof Type>[] = [];
+      for (let i = 0; i < count; i++) {
+        if (inputFieldsResolver) {
+          // eslint-disable-next-line no-await-in-loop, @typescript-eslint/no-explicit-any
+          array.push((await this.build(inputFieldsResolver)) as any);
+        } else {
+          // eslint-disable-next-line no-await-in-loop, @typescript-eslint/no-explicit-any
+          array.push((await this.build()) as any);
+        }
+      }
+      return array;
+    },
     use<T extends keyof _Traits>(
       traitName: T,
     ): TypeFactoryInterface<

src/index.test.ts

@@ -653,6 +653,66 @@ describe('TypeFactoryInterface', () => {
       expect(lastNameResolver).toHaveBeenCalledTimes(1);
     });
   });
+  describe('buildList', () => {
+    it('overrides defaultFields', async () => {
+      const BookFactory = defineBookFactory({
+        defaultFields: {
+          id: lazy(({ seq }) => `Book-${seq}`),
+          title: 'ゆゆ式',
+          author: undefined,
+        },
+      });
+      // input field is optional
+      const books1 = await BookFactory.buildList(2);
+      expect(books1).toStrictEqual([
+        {
+          id: 'Book-0',
+          title: 'ゆゆ式',
+          author: undefined,
+        },
+        {
+          id: 'Book-1',
+          title: 'ゆゆ式',
+          author: undefined,
+        },
+      ]);
+      assertType<
+        {
+          id: string;
+          title: string;
+          author: undefined;
+        }[]
+      >(books1);
+      expectTypeOf(books1).not.toBeNever();
+
+      BookFactory.resetSequence();
+
+      // Passing input fields allows overriding the default field.
+      const book2 = await BookFactory.buildList(2, {
+        title: 'ゆゆ式 100巻',
+      });
+      expect(book2).toStrictEqual([
+        {
+          id: 'Book-0',
+          title: 'ゆゆ式 100巻',
+          author: undefined,
+        },
+        {
+          id: 'Book-1',
+          title: 'ゆゆ式 100巻',
+          author: undefined,
+        },
+      ]);
+      assertType<
+        {
+          id: string;
+          title: string;
+          author: undefined;
+        }[]
+      >(book2);
+      expectTypeOf(book2).not.toBeNever();
+    });
+  });
   describe('resetSequence', () => {
     it('resets sequence', async () => {
       const BookFactory = defineBookFactory({