nhb-anagram-generator/dist/index.d.ts

A tool to generate anagrams.

import type { AnagramOptions } from './types';
/**
 * * Utility to generate unique anagrams of a word.
 * * By default returns maximum of `100` `valid (available in dictionary) anagrams`.
 * @param word The word for generating anagrams.
 * @param options The options to generate anagrams: limit the output, whether to lookup in the dictionary.
 * @returns An array of generated anagrams `(in lowercase)`. The first element is always the given word.
 */
export declare function generateAnagrams(word: string, options?: AnagramOptions): string[];
//# sourceMappingURL=index.d.ts.map