Skip to main content

process

$process​

Process the incoming value according to the provided schema

Important note: the provided schema is run in isolation in a private local context, which means that it (and its handlers) have no access to the outer schema or the global target value, and all paths are relative to the root of the provided schema.

Parameters​

  • schema (CompiledSchema, required): the compiled schema to apply to the input value. Any Schema found in a handler pipeline will be automatically compiled; Use $compile to produce a CompiledSchema from a Schema literal value.

Example​

import { Schema, SchemaResolver } from '@versionzero/schema';

// Compile a reusable sub-schema and run values through it
const resolver = new SchemaResolver();
const portSchema = await resolver.compile(
  new Schema('number').validator({$range: {min: 1, max: 65535}})
);

// portSchema is automatically compiled:
new Schema('object', {
  port: new Schema('any').validator({$process: {schema: portSchema}}),
})

// Use $compile inline to compile-then-process in a single pipeline
const mySchema = new Schema('string').validator('$non-empty');
new Schema('any').normalizer([{$compile: {$literal: mySchema}}, '$process'])