Skip to main content
Version: v0.17.0

Transform

Alias:Transform, SchemaTransform

Output:Array<T>

Attempts to transform entities in the stream so that they match the schema. Will transform strings into ints, datetimes, booleans, array, or nulls where appropriate. The properties of the transformed entities will be in the same order as in the schema For more information on schemas please see the documentation.

ParameterTypeRequiredPositionDefault ValueSummary
EntityStreamarray<entity>1Entities to transform with the schema
Schemaentity2The schema to transform into
ErrorBehaviorErrorBehavior3FailHow to behave if an error occurs.
ArrayDelimitersstring or array<string> or entityNo DelimiterStrings which can be used to delimit arrays This can either be a string, and array of string, or an entity mapping field names to strings or arrays of string
BooleanFalseFormatsstring or array<string> or entityFalse, false, No, or 0Strings which represent falsity This can either be a string, and array of string, or an entity mapping field names to strings or arrays of string Case sensitivity is determined by the CaseSensitive property
BooleanTrueFormatsstring or array<string> or entityTrue, true, Yes, or 1Strings which represent truth. This can either be a string, and array of string, or an entity mapping field names to strings or arrays of string Case sensitivity is determined by the CaseSensitive property
CaseSensitiveboolFalseWhether transformations are case sensitive
DateInputFormatsstring or array<string> or entityNo Date InputISO 8601 Date Formats to use for strings representing dates This can either be a string, and array of string, or an entity mapping field names to strings or arrays of string
NullFormatsstring or array<string> or entityNull or nullStrings which represent null This can either be a string, and array of string, or an entity mapping field names to strings or arrays of string Case sensitivity is determined by the CaseSensitive property
RemoveExtraPropertiesboolTrue if the Schema does not allow extra propertiesWhether additional properties outside the schema should be removed
RoundingPrecisiondouble0.01Doubles may be rounded to integers if the difference is less than this number