Allows for multiple field mappings when marshalling to and from JSON. Context is helpful in a scenario like the following:
@Model() class SomeModel { @Json('fName') @Json('first_name', 'source2') firstName = 'default'; }
SomeModel.fromJson({fName: 'John'})
SomeModel.fromJson({'first_name': 'John'}, 'source2')
someModel.toJson() // => {"fName":"John"}
someModel.toJson('source2') // => {"first_name":"John"}
@Json can accept a context as either its second parameter or as part of the options IJsonOptions
parameter.
Override the default decryptor logic. If provided, this will be called to perform decryption instead of
the default logic. By default, aes-256-gcm is used.
If true, this field will be encrypted toJson and decrypted fromJson.
Override the default encryptor logic. If provided, this will be called to perform encryption instead of
the default logic. By default, aes-256-gcm is used.
The json field name that is mapped to and from this property when marshalled to and from json with Model.toJson or Model.fromJson.
@Model({...}) export class SomeModel { @Json({ field: 'fn' }) firstName: string = ''; }
Explanation: firstName property of the @Model is mapped to the fn field when marshalling this model to/from
a json object.
Allows formatting a property when it's marshalled from Json to an @Model.
@Model()
class SomeModel {
@Json({
formatFromJson: (val, key) => val.ToUpperCase()
})
someProperty: string;
}
The key to use with encrypt / decrypt
If true, sub-documents that aren't part of a model will be mapped to the resulting object.
Allows formatting a property when it's marshalled to Json from an @Model.
@Model()
class SomeModel {
@Json({
formatToJson: (val, key) => val.ToUpperCase()
})
someProperty: string;
}
Allows casting fromJson. This might be used in the future for other types like Date, or enums.
Generated using TypeDoc
Defines the valid options for
@Json.