ChemPare Documentation - v0.0.0
    Preparing search index...
    • Type guard to validate if a response has a valid basic structure for a Carolina search response. Checks for the presence of required properties and correct response status code. This is a basic validation that should be followed by more detailed validation.

      Parameters

      • response: unknown

        Response object to validate

      Returns response is CarolinaSearchResponse

      Type predicate indicating if response has valid basic structure

      // Valid basic response structure
      const validResponse = {
      responseStatusCode: 200,
      "@type": "SearchResponse",
      contents: {
      ContentFolderZone: [
      {
      childRules: [
      {
      // Search result items would be here
      }
      ]
      }
      ]
      }
      };

      if (isResponseOk(validResponse)) {
      console.log("Valid basic response structure");
      console.log("Status code:", validResponse.responseStatusCode);
      } else {
      console.error("Invalid basic response structure");
      }

      // Invalid response (wrong status code)
      const wrongStatus = {
      responseStatusCode: 404,
      "@type": "SearchResponse",
      contents: {}
      };
      if (!isResponseOk(wrongStatus)) {
      console.error("Invalid response - wrong status code");
      }

      // Invalid response (missing required properties)
      const missingProps = {
      responseStatusCode: 200
      // Missing @type and contents
      };
      if (!isResponseOk(missingProps)) {
      console.error("Invalid response - missing required properties");
      }