Membrane React - v0.6.0
    Preparing search index...

    Function useDataCollectionSpec

    • Parameters

      • __namedParameters: { path?: string; key?: string; integrationId: string }

      Returns {
          dataCollectionSpec:
              | undefined
              | {
                  type: "collection";
                  key?: string;
                  name: string;
                  parametersSchema?: DataSchema;
                  fieldsSchema?: DataSchema;
                  list?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      filterFields?: string[];
                  };
                  search?: { apiRequests?: { path: unknown; method: unknown }[] };
                  match?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      fields?: string[];
                  };
                  findById?: { apiRequests?: { path: unknown; method: unknown }[] };
                  create?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      fields?: string[];
                      requiredFields?: string[];
                      excludedFields?: string[];
                  };
                  update?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      fields?: string[];
                      excludedFields?: string[];
                  };
                  delete?: { apiRequests?: { path: unknown; method: unknown }[] };
                  events?: {
                      created?: {
                          type: "push" | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      updated?: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      deleted?: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      all?: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                      [key: string]: {
                          type: "push"
                          | "pull";
                          isFullScan?: boolean;
                          isIdOnly?: boolean;
                      };
                  };
                  customFields?: boolean;
                  udm?: Record<
                      string,
                      {
                          fields?: string[];
                          extract?: Record<string, any>;
                          parse?: Record<string, any>;
                      },
                  >;
                  find?: {
                      apiRequests?: { path: unknown; method: unknown }[];
                      queryFields?: string[];
                  };
              };
          loading: boolean;
          error: unknown;
          refreshing: boolean;
      }