HelpProject/frontend/node_modules/ccount/readme.md

ccount

Count how often a character (or substring) is used in a string.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • ccount(value, character)
• Types
• Compatibility
• Security
• Related
• Contribute
• License

What is this?

This package is a small utility that helps you find how frequently a substring occurs in another string.

When should I use this?

I find this particularly useful when generating code, for example, when building a string that can either be double or single quoted. I use this utility to choose single quotes when double quotes are used more frequently, and double quotes otherwise.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install ccount

In Deno with Skypack:

import {ccount} from 'https://cdn.skypack.dev/ccount@2?dts'

In browsers with Skypack:

<script type="module">
  import {ccount} from 'https://cdn.skypack.dev/ccount@2?min'
</script>

Use

import {ccount} from 'ccount'

ccount('foo(bar(baz)', '(') // => 2
ccount('foo(bar(baz)', ')') // => 1

API

This package exports the following identifier: ccount. There is no default export.

ccount(value, character)

Count how often a character (or substring) is used in a string.

Parameters

• value (string) — value to search in
• character (string) — character (or substring) to look for

Returns

number — number of times character occurred in value.

Types

This package is fully typed with TypeScript.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

Related

• wooorm/longest-streak — count of longest repeating streak of character in value
• wooorm/direction — detect directionality: left-to-right, right-to-left, or neutral

Contribute

Yes please! See How to Contribute to Open Source.

License

MIT © Titus Wormer