typebox/docs/values/clean.md

Home | Installation | Usage | Types | Values | Syntax | TypeRegistry | TypeCheck

Clean

Use Clean to remove excess properties from a value. This function does not check the value and returns an unknown type. You should Check the result before use. Clean is a mutable operation. To avoid mutation, Clone the value first.

const T = Type.Object({
  x: Type.Number(),
  y: Type.Number(),
});

const X = Value.Clean(T, null); // const 'X = null

const Y = Value.Clean(T, { x: 1 }); // const 'Y = { x: 1 }

const Z = Value.Clean(T, { x: 1, y: 2, z: 3 }); // const 'Z = { x: 1, y: 2 }

Back to Home