diff --git a/README.md b/README.md index 1822cfd..b78b0ae 100644 --- a/README.md +++ b/README.md @@ -54,6 +54,34 @@ class User { ``` +For JSON fields you can use `JSONEncryptionTransformer`. + + +```typescript +import { Entity, Column } from "typeorm"; +import { EncryptionTransformer } from "typeorm-encrypted"; + +@Entity() +class User { + ... + + @Column({ + type: "json", + nullable: false, + transformer: new JSONEncryptionTransformer({ + key: 'e41c966f21f9e1577802463f8924e6a3fe3e9751f201304213b2f845d8841d61', + algorithm: 'aes-256-cbc', + ivLength: 16, + iv: 'ff5ac19190424b1d88f9419ef949ae56' + }) + }) + secret: object; + + ... +} + +``` + More information about transformers is available in the [typeorm docs](https://typeorm.io/#/entities/column-options). ### Subscribers