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 ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs.

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 string: The type of count. Accepts ;words', 'characters_excluding_spaces', or 'characters_including_spaces'.
  • userSettings Object: Custom settings object.

Returns

  • number: The word or character count.



Code is Poetry.