Model Transformer Api

API used for dto and model data transformations.

Properties

defaultTransformers
A collection of default transformers.

Methods

transformInbound(rules, dto) ⇒ Object
Function to transform dto values using given rules.
transformOutbound(rules, modelData) ⇒ Object
Function to transform model values using given rules.

Properties Details

defaultTransformers

A collection of default transformers.

defaultTransformers.inbound

A collection of default inbound transformers.

inbound.identity(value) ⇒ *

Function to transform value to itself.

Returns: * - Initial value.

Param Type Description
value * Value to be transformed.

inbound.boolean(value) ⇒ Boolean

Function to transform values to boolean.

Returns: Boolean - transformed value. Resolves to false if given falsy value.

Param Type Description
value Boolean Value to be transformed.

inbound.string(value) ⇒ String

Function to transform values to string.

Returns: String - transformed value. Resolves to empty string if given falsy value.

Param Type Description
value String Value to be transformed.

inbound.dateTime(value) ⇒ function

Generates a function to format string representing UTC date to local dateTime string.

Returns: function - function that returns a string representing local date.

Param Type Description
value String String representing locale for which the transform should format the output date time string to.

inbound.userName(value) ⇒ String

Function to transform value to user name.

Returns: String - user's name.

Param Type Description
value Object User value.

inbound.securableItem(value) ⇒ Object

Function to transform secured item dto to model.

Returns: Object - secured item model.

Param Type Description
value Object Secured item dto.

defaultTransformers.outbound

A collection of default outbound transformers.

outbound.identity(value) ⇒ *

Function to transform value to itself.

Returns: * - Initial value.

Param Type Description
value * Value to be transformed.

outbound.boolean(value) ⇒ Boolean

Function to transform values to boolean.

Returns: Boolean - transformed value. Resolves to false if given falsy value.

Param Type Description
value Boolean Value to be transformed.

outbound.string(value) ⇒ String

Function to transform values to string.

Returns: String - transformed value. Resolves to empty string if given falsy value.

Param Type Description
value String Value to be transformed.

outbound.securableItem(value) ⇒ Object

Function to transform secured item model to dto.

Returns: Object - secured item dto.

Param Type Description
value Object Secured item model.

transformInbound(rules, dto) ⇒ Object

Function to transform dto values using given rules.

Returns: Object - transformed data.

Param Type Description
rules Array.<function()> Array of functions used for value transformations.
dto Object Data that needs to be transformed.

transformOutbound(rules, modelData) ⇒ Object

Function to transform model values using given rules.

Returns: Object - transformed data.

Param Type Description
rules Array.<function()> Array of functions used for value transformations.
modelData Object Data that needs to be transformed.