Sanity Library Reference Docs
    Preparing search index...

    Interface TranslateTargetIncludeBeta

    interface TranslateTargetInclude {
        exclude?: AgentActionPathSegment[];
        include?: (AgentActionPathSegment | TranslateTargetInclude)[];
        path: AgentActionPathSegment | AgentActionPath;
        styleGuide?: string;
        types?: AgentActionTypeConfig;
    }

    Hierarchy

    • AgentActionTargetInclude
      • TranslateTargetInclude
    Index

    Properties

    exclude? include? path styleGuide? types?

    Properties

    exclude?: AgentActionPathSegment[]

    By default, all children up to target.maxPathDepth are included. Fields or array items not on the exclude list, are implicitly included.

    include?: (AgentActionPathSegment | TranslateTargetInclude)[]

    By default, all children up to target.maxPathDepth are included.

    When include is specified, only segments explicitly listed will be included.

    Fields or array items not on the include list, are implicitly excluded.

    path: AgentActionPathSegment | AgentActionPath
    styleGuide?: string

    String template using $variable from styleGuideParams.

    types?: AgentActionTypeConfig

    Types can be used to exclude array item types or all fields directly under the target path of a certain type. If you do exclude: ['string'] all string fields under the target will be excluded, for instance.

    types.include and types.exclude are mutually exclusive.

    Settings

    Member Visibility

    On This Page

    Properties