API Reference / @evolu/common / Type / transform

Function: transform()

function transform<FromType, ToType, TransformError>(
   fromType, 
   toType, 
   fromParent, 
toParent): TransformType<FromType, ToType, TransformError>;

Defined in: packages/common/src/Type.ts:1853

Type that transforms values between FromType and ToType.

fromParent: Converts FromType to ToType, may fail.
toParent: Converts ToType back to FromType, must not fail.

Example

// TODO: Examples

Type Parameters

Type Parameter	Default type
`FromType` extends `AnyType`	-
`ToType` extends `AnyType`	-
`TransformError` extends `TypeError`<`Capitalize`<`string`>>	`never`

Parameters

Parameter	Type
`fromType`	`FromType`
`toType`	`ToType`
`fromParent`	(`parentValue`) => `Result`<`InferType`<`ToType`>, `TransformError`>
`toParent`	(`value`) => `InferType`<`FromType`>

Returns

TransformType<FromType, ToType, TransformError>