@wordpress/wordcount/build-types/index.d.ts

WordPress word count utility.

import type { UserSettings, Strategy } from './types';
/**
 * Count some words.
 *
 * @param text         The text being processed
 * @param type         The type of count. Accepts 'words', 'characters_excluding_spaces', or 'characters_including_spaces'.
 * @param userSettings Custom settings object.
 *
 * @example
 * ```ts
 * import { count } from '@wordpress/wordcount';
 * const numberOfWords = count( 'Words to count', 'words', {} )
 * ```
 *
 * @return The word or character count.
 */
export declare function count(text: string, type: Strategy, userSettings?: UserSettings): number;
export * from './types';
//# sourceMappingURL=index.d.ts.map