Skip to content

Commit f55bb93

Browse files
committed
docs: update README to reflect renamed function
1 parent a2734a5 commit f55bb93

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -787,9 +787,9 @@ The `@Transform` decorator is given more arguments to let you configure how you
787787

788788
| Signature | Example | Description |
789789
| ------------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------- |
790-
| `@TransformClassToPlain` | `@TransformClassToPlain({ groups: ["user"] })` | Transform the method return with instanceToPlain and expose the properties on the class. |
791-
| `@TransformClassToClass` | `@TransformClassToClass({ groups: ["user"] })` | Transform the method return with instanceToInstance and expose the properties on the class. |
792-
| `@TransformPlainToClass` | `@TransformPlainToClass(User, { groups: ["user"] })` | Transform the method return with plainToInstance and expose the properties on the class. |
790+
| `@TransformInstanceToPlain` | `@TransformInstanceToPlain({ groups: ["user"] })` | Transform the method return with instanceToPlain and expose the properties on the class. |
791+
| `@TransformInstanceToInstance` | `@TransformInstanceToInstance({ groups: ["user"] })` | Transform the method return with instanceToInstance and expose the properties on the class. |
792+
| `@TransformPlainToInstance` | `@TransformPlainToInstance(User, { groups: ["user"] })` | Transform the method return with plainToInstance and expose the properties on the class. |
793793

794794
The above decorators accept one optional argument:
795795
ClassTransformOptions - The transform options like groups, version, name
@@ -814,7 +814,7 @@ class User {
814814
}
815815

816816
class UserController {
817-
@TransformClassToPlain({ groups: ['user.email'] })
817+
@TransformInstanceToPlain({ groups: ['user.email'] })
818818
getUser() {
819819
const user = new User();
820820
user.firstName = 'Snir';

0 commit comments

Comments
 (0)