haystack-nclient/dist/client/fetchAllGrids.d.ts

Project Haystack Network Client

import { HGrid } from 'haystack-core';
import { FetchMethod } from './fetchVal';
/**
 * Convenience method to fetch multiple grids from a response.
 *
 * A caller will have to check each grid to see if it's in error.
 *
 * Please note: fetching multiple grids from a response is unorthodox. This
 * was added to support the rather antiquated `evalAll` that has multiple grids
 * encoded into its response.
 *
 * @param resource The resource to request.
 * @param gridCount The number of expected grids to read.
 * @param options Optional object containing any custom settings.
 * @param fetchFunc Optional fetch function to use instead of global fetch.
 * @returns A promise that resolves to a number of grids.
 * @throws A fetch error.
 */
export declare function fetchAllGrids(resource: RequestInfo, gridCount: number, options?: RequestInit, fetchFunc?: FetchMethod): Promise<HGrid[]>;