Package Exports

@wordpress/wordcount

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@wordpress/wordcount) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Word Count

WordPress word count utility.

Installation

Install the module

npm install @wordpress/wordcount --save

Accepted Paramaters

count( text, type, userSettings )

count accepts three parameters:

text: A string containing the words/characters to be counted.
type: A string that represents the type of count. The current implementation accepts the strings 'words', 'characters_excluding_spaces', or 'characters_including_spaces'.
userSettings: An object that contains the list of regular expressions that will be used to count. See defaultSettings.js for the defaults.

Usage

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