mongodb-rag-core/build/executeCode/isReasonableResult.d.ts

Common elements used by MongoDB Chatbot Framework components.

import { DatabaseExecutionResult } from "./DatabaseExecutionResult";
export declare const REASONS: {
    readonly NULL: "Result is null";
    readonly ZERO: "Result is 0";
    readonly EMPTY_ARRAY: "Result is empty array";
    readonly EMPTY_OBJECT: "Result is empty object";
    readonly ARRAY_OF_NULL_OR_EMPTY: "Array contains null or empty string values";
    readonly MIXED_ARRAY_NULL_OR_EMPTY: "Mixed array contains null or empty string values";
    readonly REASONABLE: "Result is reasonable";
};
/**
  Checks if the result is non-empty. A 'non-empty' result is one that does not meet the following criteria:
  - null
  - 0
  - empty array
  - empty object
 */
export declare function isNonEmptyResult(result: DatabaseExecutionResult["result"]): IsReasonableResultReturnValue;
export interface IsReasonableResultReturnValue {
    success: boolean;
    reason?: string;
}
/**
 Checks if the result is reasonable. A 'reasonable' result is one that does not meet the following criteria:
 - null
 - 0
 - empty array
 - empty object
 - in array of objects, the objects do not contain `null` or `''`
 - in array of scalars, values do not contain `null` or `''`
 - in mixed array of objects and scalars, the objects do not contain `null` or `''` and the scalars do not contain `null` or `''`
 */
export declare function isReasonableResult(result: DatabaseExecutionResult["result"]): IsReasonableResultReturnValue;
//# sourceMappingURL=isReasonableResult.d.ts.map