@v4fire/client/src/base/b-virtual-scroll-new/interface/requests.ts

V4Fire client core library

/*!
 * V4Fire Client Core
 * https://github.com/V4Fire/Client
 *
 * Released under the MIT license
 * https://github.com/V4Fire/Client/blob/master/LICENSE
 */

import type { CreateRequestOptions, RequestQuery } from 'super/i-data/i-data';
import type { VirtualScrollState } from 'base/b-virtual-scroll-new/interface/component';

/**
 * Function that returns the GET parameters for a request.
 */
export interface RequestQueryFn {
	/**
	 * Returns the GET parameters for a request.
	 *
	 * @param state - the component state.
	 */
	(state: VirtualScrollState): Dictionary<Dictionary>;
}

/**
 * Requests parameters.
 */
export type VirtualScrollRequestParams = [RequestQuery, CreateRequestOptions<unknown>];