groq-builder/dist/commands/slice.d.ts

A **schema-aware**, strongly-typed GROQ query builder. It enables you to build GROQ queries using **auto-completion**, **type-checking**, and **runtime validation**.

import { ResultItem } from "../types/result-types";
declare module "../groq-builder" {
    interface GroqBuilder<TResult, TQueryConfig> {
        /**
         * Returns a single item from the results, based on the index.
         *
         * @example
         * q.star
         *  .filterByType("product")
         *  .slice(0)
         * // Result GROQ: *[_type == "product"][0]
         * // Result Type: Product
         *
         * @param index - Zero-based index to return
         */
        slice(index: number): GroqBuilder<ResultItem.InferMaybe<TResult>, TQueryConfig>;
        /**
         * Returns a range of items from the results.
         */
        slice(
        /**
         * The first index to include in the slice
         */
        start: number, 
        /**
         * The last index in the slice.
         * This item will not be included, unless 'inclusive' is set.
         */
        end: number, 
        /**
         * Whether the 'end' item should be included (via the '..' operator).
         * @default false
         */
        inclusive?: boolean): GroqBuilder<TResult, TQueryConfig>;
        /** @deprecated Use the 'slice' method */
        index: never;
        /** @deprecated Use the 'slice' method */
        range: never;
    }
}