\r\n\r\n \r\n\r\n> **TS Serializer** provides `TypeScript` decorators to help developers with serializing/deserializing TypeScript classes into and from JSON objects.\r\n\r\n\r\n## This project is a fork from [dpopescu's project](https://github.com/dpopescu/ts-serializer)\r\n\r\n### Why?\r\nThe project is not maintained anymore and there are some feature and fixes that me and my team needed:\r\n\r\n- `optional` property option, disscursed here [issue 10](https://github.com/dpopescu/ts-serializer/issues/10) - [commit here](https://github.com/delete/ts-serializer/commit/d5eb8121af08a00635d7445f50507c20a513127d)\r\n- fix to properties with falsy values such as `0` (zero) and `false` that should be valid - [commit here](https://github.com/delete/ts-serializer/commit/926f3c6d945b2ab32fa551c07912d43a469a5702)\r\n\r\n\r\n\r\n## Installation\r\n### Using npm:\r\n`npm install --save @delete21/ts-serializer`\r\n\r\n## Usage\r\n\r\nYou can find a [codesandbox playground here](https://codesandbox.io/s/ts-serializer-playground-gdbid)!\r\n\r\n### TypeScript\r\n#### Deserialization:\r\n```TypeScript \r\nimport {Serialize, SerializeProperty, Serializable} from '@delete21/ts-serializer';\r\n\r\n@Serialize({})\r\nclass MyClass extends Serializable {\r\n @SerializeProperty({\r\n map: 'username'\r\n })\r\n public name:string;\r\n}\r\n\r\nlet instance:MyClass = new MyClass();\r\n\r\nconsole.log(instance.name); // Prints `undefined`\r\n\r\ninstance.deserialize({\r\n username: 'Some Value'\r\n});\r\n\r\nconsole.log(instance.name); // Prints 'Some Value'\r\n```\r\n---\r\n#### Serialization:\r\n```TypeScript\r\nimport {Serialize, SerializeProperty, Serializable} from '@delete21/ts-serializer';\r\n\r\n@Serialize({})\r\nclass MyClass extends Serializable {\r\n @SerializeProperty({\r\n map: 'username'\r\n })\r\n public name:string;\r\n}\r\n\r\nlet instance:MyClass = new MyClass();\r\ninstance.name = 'Some Value';\r\n\r\nconsole.log(instance.serialize()); // Prints {username:'Some Value'}\r\n```\r\n### JavaScript\r\n> **Note:** Although the library was designed to be used as a decorator in TypeScript, it doesn't matter that it can't be used in plain old JavaScript. The syntax can be a little messy but the result is the same.\r\n\r\n#### Deserialization:\r\n```JavaScript\r\nvar Serialize = TSerializer.Serialize;\r\nvar SerializeProperty = TSerializer.SerializeProperty;\r\n\r\nfunction MyClass(){\r\n this.name;\r\n}\r\n\r\nSerialize({})(MyClass);\r\nSerializeProperty({\r\n map: 'username'\r\n})(MyClass.prototype, 'name');\r\n\r\nvar instance = new MyClass();\r\n\r\nconsole.log(instance.name); // Prints `undefined`\r\n\r\ninstance.deserialize({\r\n username: 'Some Value'\r\n});\r\n\r\nconsole.log(instance.name); // Prints 'Some Value'\r\n```\r\n---\r\n#### Serialization:\r\n```JavaScript\r\nvar Serialize = TSerializer.Serialize;\r\nvar SerializeProperty = TSerializer.SerializeProperty;\r\n\r\nfunction MyClass(){\r\n this.name = 'Some Value';\r\n}\r\n\r\nSerialize({})(MyClass);\r\nSerializeProperty({\r\n map: 'username'\r\n})(MyClass.prototype, 'name');\r\n\r\nvar instance = new MyClass();\r\n\r\nconsole.log(instance.serialize()); // Prints {username:'Some Value'}\r\n```\r\n## Library Options\r\nThe library allows you to pass different serialization/deserialization options both on class level and on property level. \r\n### Class Options\r\n#### root\r\nWhen you want to deserialize just a child object from the JSON you can use the `root` option.\r\n```TypeScript\r\n@Serialize({\r\n root: 'childObject'\r\n})\r\nclass MyClass extends Serializable {\r\n @SerializeProperty({})\r\n public name:string;\r\n}\r\n\r\nlet instance:MyClass = new MyClass();\r\ninstance.deserialize({\r\n childObject: {\r\n name: 'Some Value'\r\n }\r\n});\r\n\r\nconsole.log(instance.name); // Prints 'Some Value'\r\n```\r\n### Property Options\r\n#### root\r\nThe `root` option can also be used on a property.\r\n\r\n> **Note:** If `root` is already specified at class level the value is inherited to all class properties. If you want to override this, you can use hte `.` value. In this case, the property will be mapped up one level.\r\n\r\n```TypeScript\r\n@Serialize({})\r\nclass MyClass extends Serializable {\r\n @SerializeProperty({\r\n root: 'childObject'\r\n })\r\n public name:string;\r\n}\r\n\r\nlet instance:MyClass = new MyClass();\r\ninstance.deserialize({\r\n childObject: {\r\n name: 'Some Value'\r\n }\r\n});\r\n\r\nconsole.log(instance.name); // Prints 'Some Value'\r\n```\r\n---\r\n#### map\r\nWhen the property name in the JSON doesn't match with your class properties, the `map` option can be used. This option maps a property from the JSON with a different property from your class.\r\n```TypeScript\r\n@Serialize({})\r\nclass MyClass extends Serializable {\r\n @SerializeProperty({\r\n map: 'username'\r\n })\r\n public name:string;\r\n}\r\n\r\nlet instance:MyClass = new MyClass();\r\ninstance.deserialize({\r\n username: 'Some Value'\r\n});\r\n\r\nconsole.log(instance.name); // Prints 'Some Value'\r\n```\r\n---\r\n#### list\r\nThe `list` option can be used when the JSON property value is a list of items. \r\n```TypeScript\r\n@Serialize({})\r\nclass MyClass extends Serializable {\r\n @SerializeProperty({\r\n list: true\r\n })\r\n public items:string[];\r\n}\r\n\r\nlet instance:MyClass = new MyClass();\r\ninstance.deserialize({\r\n items: ['a', 'b', 'c']\r\n});\r\n\r\nconsole.log(instance.items); // Prints ['a', 'b', 'c']\r\n```\r\n---\r\n#### type\r\nWhen you want to use non-primitive types for deserialization use the `type` option.\r\n\r\n> **Note:** The `type` object should also be a `Serializable` object.\r\n\r\n```TypeScript\r\n@Serialize({})\r\nclass User extends Serializable {\r\n @SerializeProperty({})\r\n public firstName:string;\r\n @SerializeProperty({})\r\n public lastName:string;\r\n} \r\n\r\n@Serialize({})\r\nclass Profile extends Serializable {\r\n @SerializeProperty({\r\n type: User\r\n })\r\n public user:User;\r\n}\r\n\r\nlet instance:Profile = new Profile();\r\ninstance.deserialize({\r\n user: {\r\n firstName: 'John',\r\n lastName: 'Doe'\r\n }\r\n});\r\n\r\nconsole.log(instance.user.firstName); // Prints 'John'\r\nconsole.log(instance.user.lastName); // Prints 'Doe'\r\n```\r\n\r\n#### optional\r\nThe `optional` option can be used when the property or the value may not exist. \r\n```TypeScript\r\n@Serialize({})\r\nclass User extends Serializable {\r\n @SerializeProperty({})\r\n public name:string;\r\n @SerializeProperty({\r\n optional: true\r\n })\r\n public age:number;\r\n} \r\n\r\n@Serialize({})\r\nclass Profile extends Serializable {\r\n @SerializeProperty({\r\n type: User\r\n })\r\n public user:User;\r\n}\r\n\r\nlet instance:Profile = new Profile();\r\ninstance.deserialize({\r\n user: {\r\n firstName: 'John',\r\n }\r\n});\r\n\r\nconsole.log(instance.user.firstName); // Prints 'John'\r\nconsole.log(instance.user.age); // Prints 'null'\r\n```\r\n\r\n# Contribute\r\n\r\nYou can help improving this project sending PRs and helping with issues. \r\nAlso you can ping me at [Twitter](http://twitter.com/pinheirofellipe)","readmeFilename":"README.md"}
![\"npm\"](\"https://img.shields.io/npm/dt/@delete21/ts-serializer.svg\")
\r\n \r\n \r\n ![\"license\"](\"https://img.shields.io/npm/l/@delete21/ts-serializer.svg\")
\r\n \r\n \r\n ![\"GitHub](\"https://img.shields.io/github/stars/delete/ts-serializer.svg?style=social\")
\r\n \r\n