[Fix] Prevent generators from attempting to be copied (#112)

Author: planttheidea

CHANGELOG.md

@@ -1,5 +1,10 @@
 # fast-copy CHANGELOG
 
+## 4.0.2
+
+- [#112](https://github.com/planttheidea/fast-copy/pull/112) - Prevent generators from attempting to be copied (fixes
+  [#111](https://github.com/planttheidea/fast-copy/issues/111))
+
 ## 4.0.1
 
 - [#110](https://github.com/planttheidea/fast-copy/pull/110) - Fix legacy types not aligning with types from build

README.md

@@ -262,9 +262,11 @@ The following object types are copied directly, as they are either primitives, c
 implementation does not expect cloning:
 
 - `AsyncFunction`
+- `AsyncGenerator`
 - `Boolean` primitives
 - `Error`
 - `Function`
+- `Generator`
 - `GeneratorFunction`
 - `Number` primitives
 - `Null`

__tests__/index.test.ts

@@ -7,6 +7,15 @@ interface PlainObject {
   [index: number]: any;
 }
 
+function* generator() {
+  yield 'foo';
+}
+
+async function* asyncGenerator() {
+  await Promise.resolve();
+  yield 'foo';
+}
+
 const SIMPLE_TYPES: PlainObject = {
   boolean: true,
   error: new TypeError('boom'),
@@ -50,6 +59,7 @@ const COMPLEX_TYPES: PlainObject = {
   })('foo', 'bar', 'baz'),
   array: ['foo', { bar: 'baz' }],
   arrayBuffer: new ArrayBuffer(8),
+  asyncGenerator: asyncGenerator(),
   blob: new Blob(['<a id="a">hey!</a>'], { type: 'text/html' }),
   buffer: Buffer.from('this is a test buffer'),
   customPrototype: Object.create({
@@ -62,6 +72,7 @@ const COMPLEX_TYPES: PlainObject = {
   date: new Date(),
   float32Array: new Float32Array([1, 2]),
   float64Array: new Float64Array([3, 4]),
+  generator: generator(),
   int8Array: new Int8Array([5, 6]),
   int16Array: new Int16Array([7, 8]),
   int32Array: new Int32Array([9, 10]),
@@ -336,6 +347,8 @@ describe('copyStrict', () => {
       } else if (property === 'customPrototype') {
         expect(Object.getPrototypeOf(value)).toBe(Object.getPrototypeOf(COMPLEX_TYPES[property]));
         expect(value).toEqual(COMPLEX_TYPES[property]);
+      } else if (property === 'asyncGenerator' || property === 'generator') {
+        expect(value).toBe(COMPLEX_TYPES[property]);
       } else {
         // @ts-expect-error - Symbol not supported property type
         expect(value).toEqual(COMPLEX_TYPES[property]);

index.d.ts

@@ -15,10 +15,12 @@ interface State {
 interface CopierMethods {
   array?: InternalCopier<any[]>;
   arrayBuffer?: InternalCopier<ArrayBuffer>;
+  asyncGenerator?: InternalCopier<AsyncGenerator>;
   blob?: InternalCopier<Blob>;
   dataView?: InternalCopier<DataView>;
   date?: InternalCopier<Date>;
-  error?: InternalCopier<any>;
+  error?: InternalCopier<Error>;
+  generator?: InternalCopier<Generator>;
   map?: InternalCopier<Map<any, any>>;
   object?: InternalCopier<Record<string, any>>;
   regExp?: InternalCopier<RegExp>;

src/options.ts

@@ -21,10 +21,12 @@ import type { Cache } from './utils.ts';
 export interface CopierMethods {
   array?: InternalCopier<any[]>;
   arrayBuffer?: InternalCopier<ArrayBuffer>;
+  asyncGenerator?: InternalCopier<AsyncGenerator>;
   blob?: InternalCopier<Blob>;
   dataView?: InternalCopier<DataView>;
   date?: InternalCopier<Date>;
-  error?: InternalCopier<any>;
+  error?: InternalCopier<Error>;
+  generator?: InternalCopier<Generator>;
   map?: InternalCopier<Map<any, any>>;
   object?: InternalCopier<Record<string, any>>;
   regExp?: InternalCopier<RegExp>;
@@ -37,6 +39,7 @@ interface Copiers {
   Arguments: InternalCopier<Record<string, any>>;
   Array: InternalCopier<any[]>;
   ArrayBuffer: InternalCopier<ArrayBuffer>;
+  AsyncGenerator: InternalCopier<AsyncGenerator>;
   Blob: InternalCopier<Blob>;
   // eslint-disable-next-line @typescript-eslint/no-wrapper-object-types
   Boolean: InternalCopier<Boolean>;
@@ -45,6 +48,8 @@ interface Copiers {
   Error: InternalCopier<Error>;
   Float32Array: InternalCopier<ArrayBuffer>;
   Float64Array: InternalCopier<ArrayBuffer>;
+  Generator: InternalCopier<Generator>;
+
   Int8Array: InternalCopier<ArrayBuffer>;
   Int16Array: InternalCopier<ArrayBuffer>;
   Int32Array: InternalCopier<ArrayBuffer>;
@@ -89,10 +94,12 @@ export function getOptions({
   const defaultMethods = {
     array: strict ? copyArrayStrict : copyArrayLoose,
     arrayBuffer: copyArrayBuffer,
+    asyncGenerator: copySelf,
     blob: copyBlob,
     dataView: copyDataView,
     date: copyDate,
     error: copySelf,
+    generator: copySelf,
     map: strict ? copyMapStrict : copyMapLoose,
     object: strict ? copyObjectStrict : copyObjectLoose,
     regExp: copyRegExp,
@@ -121,13 +128,15 @@ export function getTagSpecificCopiers(methods: Required<CopierMethods>): Copiers
     Arguments: methods.object,
     Array: methods.array,
     ArrayBuffer: methods.arrayBuffer,
+    AsyncGenerator: methods.asyncGenerator,
     Blob: methods.blob,
     Boolean: copyPrimitiveWrapper,
     DataView: methods.dataView,
     Date: methods.date,
     Error: methods.error,
     Float32Array: methods.arrayBuffer,
     Float64Array: methods.arrayBuffer,
+    Generator: methods.generator,
     Int8Array: methods.arrayBuffer,
     Int16Array: methods.arrayBuffer,
     Int32Array: methods.arrayBuffer,