Skip to content
This repository has been archived by the owner. It is now read-only.
Branch: master
Find file History
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
..
Failed to load latest commit information.
src
.npmrc
CHANGELOG.md
README.md
package.json

README.md

@wordpress/wordcount

A utility to count words

Installation

Install the module

npm install @wordpress/wordcount --save

Accepted Paramaters

count( text, type, userSettings )

count accepts three parameters:

  1. text: A string containing the words/characters to be counted.
  2. type: A string that represents the type of count. The current implementation accepts the strings 'words', 'characters_excluding_spaces', or 'characters_including_spaces'.
  3. 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', {} )
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.