transform

Adds a transformation step to a schema, which is executed at the end of parsing and can change the output type.

// Transform with an optional pipe
const Schema = transform<TSchema, TOutput>(schema, action, pipe);

// Transform with an optional validation
const Schema = transform<TSchema, TOutput>(schema, action, validation);

Generics

• TSchema extends BaseSchema
• TOutput extends any

Parameters

• schema TSchema
• action (input: Output<TSchema>, info: TransformInfo) => TOutput
• pipe Pipe<TOutput> | undefined
• validation BaseSchema<TOutput> | undefined

Explanation

transform can be used to transform data after validation. Compared to the transformations you can perform inside pipelines, there are no rules here. So the input type can be completely different from the output type.

To transform the input at the very beginning of the process, before any validation is performed, use the coerce method.

The pipe and validation arguments can optionally be used to validate the output of the transformation.

Returns

• Schema SchemaWithTransform<TSchema, TOutput>

Examples

The following examples show how transform can be used.

Transform to length

Schema that transforms a string to its length.

const StringLengthSchema = transform(string(), (input) => input.length);

Add object entry

Schema that transforms an object to add an entry.

const UserSchema = transform(
  object({ name: string(), age: number() }),
  (input) => ({
    ...input,
    created: new Date().toISOString(),
  })
);

Related

The following APIs can be combined with transform.

Schemas

• any,
• array,
• bigint,
• blob,
• boolean,
• date,
• enum_,
• instance,
• intersect,
• lazy,
• literal,
• map,
• nan,
• never,
• nonNullable,
• nonNullish,
• nonOptional,
• null_,
• nullable,
• nullish,
• number,
• object,
• optional,
• picklist,
• record,
• set,
• special,
• string,
• symbol,
• tuple,
• undefined_,
• union,
• unknown,
• variant,
• void_

Methods

• brand,
• coerce,
• fallback,
• getDefault,
• getDefaults,
• getFallback,
• getFallbacks,
• is,
• keyof,
• merge,
• omit,
• parse,
• partial,
• pick,
• required,
• safeParse,
• unwrap