readonly

Creates a readonly transformation action.

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

Generics

  • TInput extends any

Returns

Examples

The following examples show how readonly can be used.

Readonly array

Schema for a readonly array of numbers.

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

Readonly entry

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.

Schemas

Methods

Utils

Contributors

Thanks to all the contributors who helped make this page better!

  • GitHub profile picture of fabian-hiller

Partners

Thanks to our partners who support the project ideally and financially.

Sponsors

Thanks to our GitHub sponsors who support the project financially.

  • GitHub profile picture of dailydotdev
  • GitHub profile picture of Thanaen
  • GitHub profile picture of KATT
  • GitHub profile picture of osdiab
  • GitHub profile picture of ruiaraujo012
  • GitHub profile picture of hyunbinseo
  • GitHub profile picture of F0rce
  • GitHub profile picture of caegdeveloper
  • GitHub profile picture of seahindeniz