Validation Context

Hi there, is it possible to provide custom user defined data accessible during validation?
I would like to access that data while narrowing a type. I do not need it for any type inference.

Here an simple example:

const exampleSchema = type({
  "type": type("string").narrow((n, ctx) => {

    const forbiddenStrings = ["test", "test2"] // i would like to provide this dynamically

    if (!forbiddenStrings.includes(n)) {
      return ctx.reject("string must NOT be one of the following: " + forbiddenStrings.join(", "));
    }

    return true;
  })
});

const exampleSchema = type({
  "type": type("string").narrow((n, ctx) => {

    const forbiddenStrings = ["test", "test2"] // i would like to provide this dynamically

    if (!forbiddenStrings.includes(n)) {
      return ctx.reject("string must NOT be one of the following: " + forbiddenStrings.join(", "));
    }

    return true;
  })
});

With the API i am looking for:

const exampleSchema = type({
  "type": type("string").narrow((n, ctx) => {

    const forbiddenStrings = ctx.meta.forbiddenStrings;

    if (forbiddenStrings.includes(n)) {
      return ctx.reject("string must NOT be one of the following: " + forbiddenStrings.join(", "));
    }

    return true;
  })
});

function validate(data: unknown, forbiddenStrings: string[]): void {
  const validated = exampleSchema(data, { forbiddenStrings }); // provide forbidden strings to the schema
}

const exampleSchema = type({
  "type": type("string").narrow((n, ctx) => {

    const forbiddenStrings = ctx.meta.forbiddenStrings;

    if (forbiddenStrings.includes(n)) {
      return ctx.reject("string must NOT be one of the following: " + forbiddenStrings.join(", "));
    }

    return true;
  })
});

function validate(data: unknown, forbiddenStrings: string[]): void {
  const validated = exampleSchema(data, { forbiddenStrings }); // provide forbidden strings to the schema
}

I know this is possible if i just recreate the schema in the "validate" method with the provided parameters, but i expect to lose optimizations like precompilation then.
Is there an existing method or a workaround? I did not find anything in the docs, but maybe i am just blind.

arktype•3mo ago

Nobody

Validation Context

const exampleSchema = type({
  "type": type("string").narrow((n, ctx) => {

    const forbiddenStrings = ["test", "test2"] // i would like to provide this dynamically

    if (!forbiddenStrings.includes(n)) {
      return ctx.reject("string must NOT be one of the following: " + forbiddenStrings.join(", "));
    }

    return true;
  })
});

const exampleSchema = type({
  "type": type("string").narrow((n, ctx) => {

    const forbiddenStrings = ["test", "test2"] // i would like to provide this dynamically

    if (!forbiddenStrings.includes(n)) {
      return ctx.reject("string must NOT be one of the following: " + forbiddenStrings.join(", "));
    }

    return true;
  })
});

With the API i am looking for:

const exampleSchema = type({
  "type": type("string").narrow((n, ctx) => {

    const forbiddenStrings = ctx.meta.forbiddenStrings;

    if (forbiddenStrings.includes(n)) {
      return ctx.reject("string must NOT be one of the following: " + forbiddenStrings.join(", "));
    }

    return true;
  })
});

function validate(data: unknown, forbiddenStrings: string[]): void {
  const validated = exampleSchema(data, { forbiddenStrings }); // provide forbidden strings to the schema
}

const exampleSchema = type({
  "type": type("string").narrow((n, ctx) => {

    const forbiddenStrings = ctx.meta.forbiddenStrings;

    if (forbiddenStrings.includes(n)) {
      return ctx.reject("string must NOT be one of the following: " + forbiddenStrings.join(", "));
    }

    return true;
  })
});

function validate(data: unknown, forbiddenStrings: string[]): void {
  const validated = exampleSchema(data, { forbiddenStrings }); // provide forbidden strings to the schema
}

Validation Context

Similar Threads

Validation Context

Similar Threads

Similar Threads

Similar Threads