Sanity Library Reference Docs
    Preparing search index...

    Interface ValidationContext

    A context object passed around during validation. This includes the Rule.custom context.

    e.g.

    Rule.custom((_, validationContext) => {
      // ...
    })`
    interface ValidationContext {
        document?: SanityDocument;
        environment: "studio" | "cli";
        getClient: (options: { apiVersion: string }) => SanityClient$1;
        getDocumentExists?: (
            options: { id: string; signal?: AbortSignal },
        ) => Promise<boolean>;
        hidden?: boolean;
        i18n: LocaleSource;
        parent?: unknown;
        path?: Path;
        schema: Schema;
        signal?: AbortSignal;
        type?: SchemaType;
    }

    Hierarchy (View Summary)

    Index

    Properties

    document? environment getClient getDocumentExists? hidden? i18n parent? path? schema signal? type?

    Properties

    document?: SanityDocument
    environment: "studio" | "cli"
    getClient: (options: { apiVersion: string }) => SanityClient$1
    getDocumentExists?: (
        options: { id: string; signal?: AbortSignal },
    ) => Promise<boolean>
    hidden?: boolean

    Whether this field is hidden for any reason (either itself or any of its ancestors).

    i18n: LocaleSource

    Internationalization utilities, for translation of validation messages

    See LocaleSource for details.

    parent?: unknown
    path?: Path
    schema: Schema
    signal?: AbortSignal

    Signal used to cancel validation and any work it starts.

    type?: SchemaType

    Settings

    Member Visibility

    On This Page

    Properties