Typescript Enum array raises CircularDependencyError

I’m submitting a…


[ ] Regression 
[x ] Bug report
[ ] Feature request
[ ] Documentation issue or request
[ ] Support request => Please do not submit support request here, instead post your question on Stack Overflow.

Current behavior

using an enum array in a typescript object causes this error:

Error: A circular dependency has been detected (property key: "roles").
Please, make sure that each side of a bidirectional relationships are using lazy resolvers ("type: () => ClassType").

not the same, but maybe related to #507

Expected behavior

no error

Minimal reproduction of the problem with instructions

GitHub Repository to reproduce the issue.

clone the repo
npm install
npm run start:api

See file: create-cat.dto.ts

export class CreateCatDto {
  readonly name: string;
  readonly age: number;
  readonly breed: string;

  /**
   * using an enum array causes this exception:
   *
   *   Error: A circular dependency has been detected (property key: "roles").
   *   Please, make sure that each side of a bidirectional relationships are using lazy resolvers ("type: () => ClassType").
   */
  readonly roles: RoleEnum[];
}

Environment


Nest version: 7.4.2
 
For Tooling issues:
- Node version: 14.3.0
- Platform:  Windows 10 64-bit

Issue Analytics

State:
Created 3 years ago
Comments:10 (10 by maintainers)

Top GitHub Comments

1reaction

tmtroncommented, Aug 25, 2020

Follow-up: I managed to workaround the issue using this comment:

here is a branch of my repo where the workaround is applied
Note that this workaround may be a bad idea

1reaction

nartccommented, Aug 24, 2020

@tmtron I looked at your repo and was able to run with the following changes:

export class Cat {
  @ApiProperty({
    example: 'Maine Coon',
    description: 'The breed of the Cat',
    required: true,
    isArray: true,
    enum: RoleEnum,
  })
  readonly roles?: RoleEnum[];
}

I don’t know where you get type: () => [RoleEnum] from for enum field. That syntax is specifically for nested classes. Can you make that same change in your code to see if it works?