Skip to content

Conversation

@butchmarshall
Copy link

@butchmarshall butchmarshall commented Oct 6, 2024

Description

The class-transformer package implements the plainToClass method, which as its name suggests is used to map a plain object to a class.

This plugin decorates the generated classes with the required decorators to make this method work.

Related #855

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as
    expected)
  • This change requires a documentation update

Screenshots/Sandbox (if appropriate/relevant):

Adding links to sandbox or providing screenshots can help us understand more about this PR and take
action on it as appropriate

How Has This Been Tested?

  • should decorate @expose() on matching class properties and @type on all nested classes

This will test both the classWhitelist and classNamePattern config properties to ensure only the matched classes are decorated.

Test Environment:

  • OS: Ubuntu 22.04.4 LTS
  • @graphql-codegen/class-transformer-decorators:
  • NodeJS: v20.17.0

Checklist:

  • I have followed the
    CONTRIBUTING doc and the
    style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@changeset-bot
Copy link

changeset-bot bot commented Oct 6, 2024

⚠️ No Changeset found

Latest commit: e29e536

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@yonathan9669
Copy link

yonathan9669 commented Jun 23, 2025

Hey, it's been a while since you made this feature. Any idea when it could be merged? I assume you are using it in your projects.

Would it be possible for you to drop off here a simple & effective quick setup guide for this?

Also, if it is possible, your impressions during the time using it, like:

  • Suggestions to avoid errors.
  • Tips to use it properly.

I'm trying to prevent my team from having to manually map each entity in order to properly use them as classes and build logic only on the required ones.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants