Skip to content

Readme updated #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2018
Merged

Readme updated #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 38 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,6 +96,20 @@ deserialize(json: any, type: any)
// Import decorators from library
import { Serializable, JsonProperty } from './../../src';

// Enums
export enum Gender {
female,
male,
other
}

export enum Status {
alive = 'Alive',
sick = 'Sick',
deadAndAlive = 'Dead and alive',
dead = 'Dead'
}


// Create a serializable class: Employee

Expand All @@ -111,8 +125,10 @@ export class Employee {
public birthdate: Date;
@JsonProperty()
public email: string;

// Enum value (number)
@JsonProperty()
public gender: string;
public gender: Gender;

public constructor() { }

Expand All @@ -133,7 +149,11 @@ export class Animal {
@JsonProperty()
public numberOfPaws: number;
@JsonProperty()
public gender: string;
public gender: Gender;

// Enum value (string)
@JsonProperty()
public status: Status;

// Specify the property name of json property if needed
@JsonProperty('childrenIdentifiers')
Expand Down Expand Up @@ -205,7 +225,7 @@ export class Zoo {

```typescript
// data.ts
export const json: any = {
export const data: any = {
'id': 15,
'name': 'The Greatest Zoo',
'city': 'Bordeaux',
Expand All @@ -215,36 +235,36 @@ export const json: any = {
'name': 'Bob Razowsky',
'birthdate': '1984-04-03T22:00:00.000Z',
'email': 'bob.razowsky@tgzoo.fr',
'gender': 'male'
'gender': 1
},
'employees': [
{
'id': 1,
'name': 'Bob Razowsky',
'birthdate': '1984-04-03T22:00:00.000Z',
'email': 'bob.razowsky@tgzoo.fr',
'gender': 'male'
'gender': 1
},
{
'id': 2,
'name': 'Mikasa Ackerman',
'birthdate': '1984-01-11T22:00:00.000Z',
'email': 'mikasa.ackerman@tgzoo.fr',
'gender': 'female'
'gender': 0
},
{
'id': 3,
'name': 'Red Redington',
'birthdate': '1970-12-04T22:00:00.000Z',
'email': 'red.redington@tgzoo.fr',
'gender': 'male'
'gender': 1
},
{
'id': 4,
'name': 'Fried Richter',
'birthdate': '1994-04-01T22:00:00.000Z',
'email': 'fried.richter@tgzoo.fr',
'gender': 'male'
'gender': 1
}
],
'Panthers': [
Expand All @@ -253,31 +273,34 @@ export const json: any = {
'name': 'Bagheera',
'birthdate': '2010-01-11T22:00:00.000Z',
'numberOfPaws': 4,
'gender': 'male',
'gender': 1,
'childrenIdentifiers': [
2,
3
],
'color': 'black',
'isSpeckled': false
'isSpeckled': false,
'status': 'Sick'
},
{
'id': 2,
'name': 'Jolene',
'birthdate': '2017-03-10T22:00:00.000Z',
'numberOfPaws': 4,
'gender': 'female',
'gender': 0,
'color': 'blond',
'isSpeckled': true
'isSpeckled': true,
'status': 'Alive'
},
{
'id': 3,
'name': 'Chatchat',
'name': 'Schrodinger',
'birthdate': '2015-03-05T22:00:00.000Z',
'numberOfPaws': 4,
'gender': 'female',
'gender': 1,
'color': 'brown',
'isSpeckled': false
'isSpeckled': false,
'status': 'Dead and alive'
}
]
};
Expand Down