Sanity Library Reference Docs
    Preparing search index...

    Interface GenerateTargetIncludeBeta

    Hierarchy

    • AgentActionTargetInclude
      • GenerateTargetInclude
    Index

    Properties

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

    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.

    operation?: GenerateOperation

    Sets the operation for this path, and all its children. This overrides any operation set parents or the root target.

    • #GenerateTarget.operation
    • #include

    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.