/** * A generator function that produces a function to rename keys. * * @param {OptionsToRenameKeys} options - Options to rename keys * @returns {Object} - A renamer object. * * Example: * * renamer({ prefix: 'a', keys: ['a', 'b'] }).get() * renamer({ prefix: 'a', separator: '-' }).get() * renamer().setPrefix('a') * .setSeparator('-') * .setKeys(['a', 'b']) * .get() * renamer().setPrefix('a').get() * renamer().setSuffix('b').get() * renamer().setKeys(['a', 'b']).get() */ export function renamer(options?: OptionsToRenameKeys): Object; export type OptionsToRenameKeys = { /** * - The prefix to add to the key. */ prefix?: string | undefined; /** * - The suffix to add to the key. */ suffix?: string | undefined; /** * - The separator to use between the key and the prefix or suffix. */ separator?: string | undefined; /** * - The keys to rename. */ keys?: any[] | undefined; };