npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@nikitababko/text-analyzer

v1.0.0

Published

Text analyzer

Downloads

4

Readme

Text Analyzer

Text Analyzer is a simple TypeScript tool that provides functions to analyze text. It allows you to count the number of words, characters, and special symbols in a string.

Installation

First, install the dependencies if they are not already installed:

# With pnpm
pnpm install

# With npm
npm install

# With yarn
yarn install

Usage

Counting Words: getCountWords

The getCountWords function counts the number of words in a given text. Words are separated by spaces and other whitespace characters.

import { getCountWords } from './path/to/module';

const text = 'Hello, world! This is a simple text analyzer.';
const wordCount = getCountWords(text);

console.log(`Number of words: ${wordCount}`); // Output: Number of words: 7

Counting Characters: getCharsCount

The getCharsCount function counts the number of characters in a string, excluding line breaks ( and ).

import { getCharsCount } from './path/to/module';

const text = 'Hello, world!\nThis is a simple text analyzer.';
const charCount = getCharsCount(text);

console.log(`Number of characters: ${charCount}`); // Output: Number of characters: 41

Counting Special Symbols: getSymbolsCount

The getSymbolsCount function counts the number of special symbols in a string. The special symbols considered are: !"#$%&'()*+,-./:;<=>?@[]^_{|}~`.

import { getSymbolsCount } from './path/to/module';

const text = 'Hello, world! How are you today?';
const symbolCount = getSymbolsCount(text);

console.log(`Number of special symbols: ${symbolCount}`); // Output: Number of special symbols: 3

API

getCountWords(text: string): number

Counts the number of words in a string.

  • Parameters:

    • text: The string of text to analyze.
  • Returns:

    • The number of words in the string.

getCharsCount(text: string): number

Counts the number of characters in a string, excluding line breaks.

  • Parameters:

    • text: The string of text to analyze.
  • Returns:

    • The number of characters in the string (excluding line breaks).

getSymbolsCount(text: string): number

Counts the number of special symbols in a string.

  • Parameters:

    • text: The string of text to analyze.
  • Returns:

    • The number of special symbols in the string.

License

This project is licensed under the MIT License. See the LICENSE file for more details.