readonly

Creates a readonly transformation action.

const Action = v.readonly<TInput>();

Generics

The following examples show how readonly can be used.

Schema for a readonly array of numbers.

const ArraySchema = v.pipe(v.array(v.number()), v.readonly());

Object schema with an entry marked as readonly.

const ObjectSchema = v.object({
  name: v.string(),
  username: v.pipe(v.string(), v.readonly()),
  age: v.number(),
});

The following APIs can be combined with readonly.