eslint-plugin-perfectionist/dist/utils/build-options-by-group-index-computer.d.ts

ESLint plugin for sorting various data such as objects, imports, types, enums, JSX props, etc.

import { OptionsByGroupIndexComputer } from './sort-nodes-by-groups.js'
import { CommonGroupsOptions } from '../types/common-groups-options.js'
import { CommonOptions } from '../types/common-options.js'
type Options = Pick<
  CommonGroupsOptions<string, unknown, unknown>,
  'customGroups' | 'groups'
> &
  CommonOptions
/**
 * Creates a function that retrieves overridden options for a specific group
 * index.
 *
 * Returns a closure that captures the options and provides a convenient way to
 * get overridden options for any group index. This is used in sorting
 * algorithms that need to apply different sorting rules to different groups.
 *
 * @example
 *
 * ```ts
 * const getOverriddenOptions = buildOptionsByGroupIndexComputer(options)
 * const group1Options = getOverriddenOptions(0)
 * const group2Options = getOverriddenOptions(1)
 * ```
 *
 * @param options - Base sorting options with group configuration.
 * @returns Function that takes a group index and returns overridden options.
 */
export declare function buildOptionsByGroupIndexComputer<T extends Options>(
  options: T,
): OptionsByGroupIndexComputer<T>
export {}