/** * Count some words. * * @param {string} text The text being processed * @param {GCWordCountStrategy} type The type of count. Accepts 'words', 'characters_excluding_spaces', or 'characters_including_spaces'. * @param {GCWordCountUserSettings} userSettings Custom settings object. * * @example * ```js * import { count } from '@gechiui/wordcount'; * const numberOfWords = count( 'Words to count', 'words', {} ) * ``` * * @return {number} The word or character count. */ export function count(text: string, type: GCWordCountStrategy, userSettings: GCWordCountUserSettings): number; export type GCWordCountSettings = import('./defaultSettings').GCWordCountDefaultSettings; export type GCWordCountUserSettings = import('./defaultSettings').GCWordCountUserSettings; /** * Possible ways of counting. */ export type GCWordCountStrategy = 'words' | 'characters_excluding_spaces' | 'characters_including_spaces'; //# sourceMappingURL=index.d.ts.map