import {
  GroupWithOverridesOption,
  GroupsOptions,
} from '../types/common-groups-options.js'
/**
 * Type guard to check if a group option is a group with overrides
 * configuration.
 *
 * Determines whether a group element is a special configuration object that
 * contains group settings rather than being a regular group name or newlines
 * option.
 *
 * @example
 *
 * ```ts
 * const groups = [
 *   'imports',
 *   { group: 'foo', commentAbove: '// Components' },
 *   'components',
 *   { newlinesBetween: 1 },
 *   'utils',
 * ]
 *
 * isGroupWithOverridesOption(groups[0]) // false (string)
 * isGroupWithOverridesOption(groups[1]) // true
 * isGroupWithOverridesOption(groups[3]) // false (newlines option)
 * ```
 *
 * @param groupOption - A single element from the groups configuration array.
 * @returns True if the element is a group with overrides configuration object.
 */
export declare function isGroupWithOverridesOption<
  CustomTypeOption extends string,
  AdditionalSortOptions,
>(
  groupOption: GroupsOptions<CustomTypeOption, AdditionalSortOptions>[number],
): groupOption is GroupWithOverridesOption<
  CustomTypeOption,
  AdditionalSortOptions
>