Skip to content

Latest commit

 

History

History

wordcount

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 

Word Count

WordPress word count utility.

Installation

Install the module

npm install @wordpress/wordcount --save

This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for such language features and APIs, you should include the polyfill shipped in @wordpress/babel-preset-default in your code.

API

count

Count some words.

Usage

import { count } from '@wordpress/wordcount';
const numberOfWords = count( 'Words to count', 'words', {} );

Parameters

  • text string: The text being processed
  • type WPWordCountStrategy: The type of count. Accepts 'words', 'characters_excluding_spaces', or 'characters_including_spaces'.
  • userSettings WPWordCountUserSettings: Custom settings object.

Returns

  • number: The word or character count.



Code is Poetry.