Back to reference

DocumentStats

Statistics about the user-entered text.

Try it nowopen in new window

interface DocumentStats {
  charsCount: number;
  readabilityScore: number;
  readingTime: Time;
  speakingTime: Time;
  suggestionsCount: number;
  wordsCount: number;
}

Properties

charsCountType: number

Current number of characters, including whitespace.

readabilityScoreType: number

Readability score using the Flesch reading-ease testopen in new window.

Higher scores indicate material that is easier to read. The range for typical text is 0–100, but we surface the exact score, even if lower or higher.

Note: Readability score should only be used with longer texts.

readingTimeType: Time

Expected time needed by an average reader to read the text (250 wpm).

speakingTimeType: Time

Expected time needed by an average speaker to speak the text aloud (130 wpm).

suggestionsCountType: number

Current number of suggestions.

wordsCountType: number

Current number of words.

Last Updated: 11/22/2022, 10:34:55 PM