Sanity Library Reference Docs
    Preparing search index...
    • Parameters

      • action: {
            description?: string;
            effects?: AuthoringEffect[];
            filter?: string;
            group?: GroupMembership;
            name: string;
            ops?: AuthoringOp[];
            params?: {
                description?: string;
                name: string;
                options?: ChoiceOptions;
                required?: boolean;
                title?: string;
                type:
                    | "string"
                    | "number"
                    | "boolean"
                    | "actor"
                    | "url"
                    | "doc.ref"
                    | "doc.refs"
                    | "dateTime"
                    | "json";
                validation?: ScalarValidation;
            }[];
            semantics?: ActionSemantic[];
            spawn?: {
                context?: { [key: string]: string };
                definition: { name: string; version?: number | "latest" };
                forEach: string;
                onExit?: "detach" | "abort";
                with?: { [key: string]: string };
            };
            title?: string;
            when?: string;
        } & { roles?: string[]; status?: TerminalActivityStatus }

      Returns {
          description?: string;
          effects?: AuthoringEffect[];
          filter?: string;
          group?: GroupMembership;
          name: string;
          ops?: AuthoringOp[];
          params?: {
              description?: string;
              name: string;
              options?: ChoiceOptions;
              required?: boolean;
              title?: string;
              type:
                  | "string"
                  | "number"
                  | "boolean"
                  | "actor"
                  | "url"
                  | "doc.ref"
                  | "doc.refs"
                  | "dateTime"
                  | "json";
              validation?: ScalarValidation;
          }[];
          semantics?: ActionSemantic[];
          spawn?: {
              context?: { [key: string]: string };
              definition: { name: string; version?: number | "latest" };
              forEach: string;
              onExit?: "detach" | "abort";
              with?: { [key: string]: string };
          };
          title?: string;
          when?: string;
      } & { roles?: string[]; status?: TerminalActivityStatus }