Interface Field

example

Using a model field's arrayOf configuration for assigning an array sub-model // Without the arrayOf, addresses won't be modeled by Paris.

@EntityField({ arrayOf: Address })
addresses: Array<Address>

If an entity has the following property definition:

@EntityField()
name:string;

Then when creating the model, if the raw data contains a name property with value 'Anna', the resulting model will have a name property with value 'Anna'.

example

Mapping from a different raw data property with data If your raw data has properties in snake-case rather than camel-case, you'd need to map the properties:

@EntityField({ data: "creation_date" })
creationData: Date;

example

Using the first available value from the raw data for the model's property If an array of strings is provided for data, Paris will assign to the model's property value the first value from the raw data which isn't undefined or null:

@EntityField({ data: ['creation_date', 'init_date', 'start_date'] })
date: Date;

If the raw data is: { "creation_date": null, "start_date": 1532422166428 }

Then the model's date property will have a value of Date(1532422166428), since both creation_date and init_date have no value in the data.

example

Using '__self' for data to pass the whole raw data In the case when we want to separate some properties of the raw data to a sub-model, it's possible to use the special value '__self' for the data field configuration. This passes the whole raw data object to the field's creation, rather than just the value of a property. e.g:

Person extends EntityModelBase{
        @EntityField()
        name:string;

        @EntityField({ data: '__self' })
        address:Address;
}

In case we want to separate all address properties from a user into an encapsulated object, for the following raw data:

{
        "name": "Anna",
        "street": "Prinsengracht 263-267",
        "zip": "1016 GV",
        "city": "Amsterdam",
        "country": "Holland"
}

example

Parsing a bitwise value into an array

@EntityField({
        arrayOf: NotificationFormat,
        parse: (formatBitWise: number) => {
            return notificationFormatValues.reduce((formats: Array<number>, notificationFormat) => {
                return notificationFormat.id > 0 && (formatBitWise & notificationFormat.id) ? [...formats, notificationFormat.id] : formats;
            }, []);
        },
    })
formatFlavor: Array<NotificationFormat>;

param

The field's data from the raw data

param

The whole object's raw data

param

The query (if any) that was used for getting the data

returns

new raw data.

example

Assigning ZIP code only if street exists

@EntityField({ require: "street" })
zip:string;

example

Assigning ZIP code only if both street and country exist

@EntityField({ require: (data:AddressRawData) => data.street && data.country })
zip:string;

default

false