Interface Rule

interface Rule {
    valueOfField: (path: string | string[]) => FieldReference;
    all(children: Rule[]): Rule;
    assetRequired(): Rule;
    clone(): Rule;
    cloneWithRules(rules: RuleSpec[]): Rule;
    custom<T = unknown>(
        fn: CustomValidator<T>,
        options?: { bypassConcurrencyLimit?: boolean },
    ): Rule;
    either(children: Rule[]): Rule;
    email(): Rule;
    error(message?: string | LocalizedValidationMessages): Rule;
    fields(rules: FieldRules): Rule;
    greaterThan(num: number | FieldReference): Rule;
    info(message?: string | LocalizedValidationMessages): Rule;
    integer(): Rule;
    isRequired(): boolean;
    length(len: number | FieldReference): Rule;
    lessThan(num: number | FieldReference): Rule;
    lowercase(): Rule;
    max(len: string | number | FieldReference): Rule;
    media<
        T extends
            "sanity.fileAsset"
            | "sanity.imageAsset"
            | "sanity.videoAsset" =
            | "sanity.fileAsset"
            | "sanity.imageAsset"
            | "sanity.videoAsset",
    >(
        fn: MediaValidator<T>,
    ): Rule;
    merge(rule: Rule): Rule;
    min(len: string | number | FieldReference): Rule;
    negative(): Rule;
    optional(): Rule;
    positive(): Rule;
    precision(limit: number | FieldReference): Rule;
    reference(): Rule;
    regex(
        pattern: RegExp,
        name: string,
        options: { invert?: boolean; name?: string },
    ): Rule;
    regex(pattern: RegExp, options: { invert?: boolean; name?: string }): Rule;
    regex(pattern: RegExp, name: string): Rule;
    regex(pattern: RegExp): Rule;
    required(): Rule;
    reset(): this;
    type(
        targetType:
            | "string"
            | "number"
            | "boolean"
            | "object"
            | "date"
            | "array"
            | RuleTypeConstraint,
    ): Rule;
    unique(): Rule;
    uppercase(): Rule;
    uri(options?: UriValidationOptions): Rule;
    valid(value: unknown): Rule;
    validate(
        value: unknown,
        options: ValidationContext & {},
    ): Promise<ValidationMarker[]>;
    warning(message?: string | LocalizedValidationMessages): Rule;
}

Properties

valueOfField

valueOfField: (path: string | string[]) => FieldReference

Takes in a path and returns an object with a symbol.

When the validation lib sees this symbol, it will use the provided path to get a value from the current field's parent and use that value as the input to the Rule.

The path that's given is forwarded to lodash/get

fields: [
// ...
  {
    // ...
    name: 'highestTemperature',
    type: 'number',
    validation: (Rule) => Rule.positive().min(Rule.valueOfField('lowestTemperature')),
    // ...
  },
]

Methods

all

all(children: Rule[]): Rule
Parameters
- children: Rule[]
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2893

assetRequired

assetRequired(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2938

clone

clone(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2889

cloneWithRules

cloneWithRules(rules: RuleSpec[]): Rule
Parameters
- rules: RuleSpec[]
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2890

custom

custom<T = unknown>(
fn: CustomValidator<T>,
options?: { bypassConcurrencyLimit?: boolean },
): Rule
Type Parameters
- T = unknown
Parameters
- fn: CustomValidator<T>
- Optionaloptions: { bypassConcurrencyLimit?: boolean }
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2897

either

either(children: Rule[]): Rule
Parameters
- children: Rule[]
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2894

email

email(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2933

error

error(message?: string | LocalizedValidationMessages): Rule
Parameters
- Optionalmessage: string | LocalizedValidationMessages
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2884

fields

fields(rules: FieldRules): Rule
Parameters
- rules: FieldRules
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2937

greaterThan

greaterThan(num: number | FieldReference): Rule
Parameters
- num: number | FieldReference
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2912

info

info(message?: string | LocalizedValidationMessages): Rule
Parameters
- Optionalmessage: string | LocalizedValidationMessages
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2886

integer

integer(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2908

isRequired

isRequired(): boolean
Returns boolean
- Defined in packages/@sanity/types/lib/index.d.ts:2888

length

length(len: number | FieldReference): Rule
Parameters
- len: number | FieldReference
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2906

lessThan

lessThan(num: number | FieldReference): Rule
Parameters
- num: number | FieldReference
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2913

lowercase

lowercase(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2915

max

max(len: string | number | FieldReference): Rule
Parameters
- len: string | number | FieldReference
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2905

media

media<
    T extends
        "sanity.fileAsset"
        | "sanity.imageAsset"
        | "sanity.videoAsset" =
        | "sanity.fileAsset"
        | "sanity.imageAsset"
        | "sanity.videoAsset",
>(
    fn: MediaValidator<T>,
): Rule
Type Parameters
- T extends "sanity.fileAsset" | "sanity.imageAsset" | "sanity.videoAsset" = "sanity.fileAsset" | "sanity.imageAsset" | "sanity.videoAsset"
Parameters
- fn: MediaValidator<T>
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2903

merge

merge(rule: Rule): Rule
Parameters
- rule: Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2891

min

min(len: string | number | FieldReference): Rule
Parameters
- len: string | number | FieldReference
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2904

negative

negative(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2911

optional

optional(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2895

positive

positive(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2910

precision

precision(limit: number | FieldReference): Rule
Parameters
- limit: number | FieldReference
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2909

reference

reference(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2936

regex

regex(
    pattern: RegExp,
    name: string,
    options: { invert?: boolean; name?: string },
): Rule
Parameters
- pattern: RegExp
- name: string
- options: { invert?: boolean; name?: string }
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2916
regex(pattern: RegExp, options: { invert?: boolean; name?: string }): Rule
Parameters
- pattern: RegExp
- options: { invert?: boolean; name?: string }
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2924
regex(pattern: RegExp, name: string): Rule
Parameters
- pattern: RegExp
- name: string
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2931
regex(pattern: RegExp): Rule
Parameters
- pattern: RegExp
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2932

required

required(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2896

reset

reset(): this
Returns this
- Defined in packages/@sanity/types/lib/index.d.ts:2887

type

type(
    targetType:
        | "string"
        | "number"
        | "boolean"
        | "object"
        | "date"
        | "array"
        | RuleTypeConstraint,
): Rule
Parameters
- targetType:
      | "string"
      | "number"
      | "boolean"
      | "object"
      | "date"
      | "array"
      | RuleTypeConstraint
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2892

unique

unique(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2935

uppercase

uppercase(): Rule
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2914

uri

uri(options?: UriValidationOptions): Rule
Parameters
- Optionaloptions: UriValidationOptions
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2934

valid

valid(value: unknown): Rule
Parameters
- value: unknown
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2907

validate

validate(
value: unknown,
options: ValidationContext & {},
): Promise<ValidationMarker[]>
Parameters
- value: unknown
- options: ValidationContext & {}
Returns Promise<ValidationMarker[]>
- Defined in packages/@sanity/types/lib/index.d.ts:2939

warning

warning(message?: string | LocalizedValidationMessages): Rule
Parameters
- Optionalmessage: string | LocalizedValidationMessages
Returns Rule
- Defined in packages/@sanity/types/lib/index.d.ts:2885

Interface Rule

Index

Properties

Methods

Properties

valueOfField

Methods

all

Parameters

Returns Rule

assetRequired

Returns Rule

clone

Returns Rule

cloneWithRules

Parameters

Returns Rule

custom

Type Parameters

Parameters

Returns Rule

either

Parameters

Returns Rule

email

Returns Rule

error

Parameters

Returns Rule

fields

Parameters

Returns Rule

greaterThan

Parameters

Returns Rule

info

Parameters

Returns Rule

integer

Returns Rule

isRequired

Returns boolean

length

Parameters

Returns Rule

lessThan

Parameters

Returns Rule

lowercase

Returns Rule

max

Parameters

Returns Rule

media

Type Parameters

Parameters

Returns Rule

merge

Parameters

Returns Rule

min

Parameters

Returns Rule

negative

Returns Rule

optional

Returns Rule

positive

Returns Rule

precision

Parameters

Returns Rule

reference

Returns Rule

regex

Parameters

Returns Rule

Parameters

Returns Rule

Parameters