import { NameOrder, CapsRange } from './types.js'; /** * A set of values to handle specific positions for list of names. * * As for list of names, this helps to follow a specific order based on the * count of elements. It is expected that the list has to be between two and * five elements. Also, the order of appearance set in the configuration * influences how the parsing is carried out. * * Ordered by first name, the parser works as follows: * - 2 elements: firstName lastName * - 3 elements: firstName middleName lastName * - 4 elements: prefix firstName middleName lastName * - 5 elements: prefix firstName middleName lastName suffix * * Ordered by last name, the parser works as follows: * - 2 elements: lastName firstName * - 3 elements: lastName firstName middleName * - 4 elements: prefix lastName firstName middleName * - 5 elements: prefix lastName firstName middleName suffix * * For example, `Jane Smith` (ordered by first name) is expected to be indexed: * `['Jane', 'Smith']`. */ export declare class NameIndex { readonly prefix: number; readonly firstName: number; readonly middleName: number; readonly lastName: number; readonly suffix: number; /** The minimum number of parts in a list of names. */ static get min(): number; /** The maximum number of parts in a list of names. */ static get max(): number; protected constructor(prefix: number, firstName: number, middleName: number, lastName: number, suffix: number); /** The default or base indexing: firstName lastName. */ static base(): NameIndex; /** * Gets the name index for a list of names based on the `count` of elements * and their `order` of appearance. */ static when(order: NameOrder, count?: number): NameIndex; static only({ prefix, firstName, middleName, lastName, suffix }: Record): NameIndex; toJson(): Record; json: () => Record; } /** Capitalizes a string via a `CapsRange` option. */ export declare function capitalize(str: string, range?: CapsRange): string; /** Decapitalizes a string via a `CapsRange` option. */ export declare function decapitalize(str: string, range?: CapsRange): string; /** Toggles a string representation. */ export declare function toggleCase(str: string): string; export declare function isStringArray(value?: unknown): value is string[];