@adobe/data - v0.10.30
    Preparing search index...

    Function ProgressiveResultSchema

    • Returns a json schema for a progressive result with the specified result schemas.

      Type Parameters

      • T extends ResultSchema
      • E extends ResultSchema

      Parameters

      • successSchema: T
      • errorSchema: E

      Returns {
          oneOf: readonly [
              Omit<T, "properties" | "required"> & {
                  properties: { error: T };
                  required: readonly ["progress"];
                  type: "object";
              },
              Omit<T, "properties" | "required"> & {
                  properties: { progress: { const: 1 } };
                  required: readonly [string, "progress"];
                  type: "object";
              },
              Omit<T, "properties" | "required"> & {
                  properties: { error: E };
                  required: readonly ["error"];
                  type: "object";
              },
          ];
      }

    Settings

    Member Visibility