# normal-case-generator

> This file helps generate capitalized starting letters of text

Latest version **1.0.1** (published 2022-07-10) · ISC license · 0 weekly downloads

## Install

```sh
npm install normal-case-generator
pnpm add normal-case-generator
yarn add normal-case-generator
bun add normal-case-generator
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-07-10 |
| First published | 2022-07-10 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 6.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | tylerdgenius |
| Maintainers | tylerdgenius |

## Links

- npm: https://www.npmjs.com/package/normal-case-generator
- Repository: https://github.com/tylerdgenius/normal-case-generator
- Homepage: https://github.com/tylerdgenius/normal-case-generator#readme
- Issues: https://github.com/tylerdgenius/normal-case-generator/issues
- npm.io page: https://npm.io/package/normal-case-generator

## Recent versions

- 1.0.1 (latest) — 2022-07-10
- 1.0.0 — 2022-07-10

## README

��# normal-case-generator

# Description

This package is used to help capitalize select parts of a string, the first letter of a string or all first letters in the string

# Usage

```js
import normalCaseGenerator from 'normal-case-generator'

const output = normalCaseGenerator(value, options)

output: This contains the returned text value based on {value, options} that are passed into the normalCaseGenerator fn

value* - required | string
options* - optional | {
    filter: 'first' or 'all' or 'single',
    textToCapitalize: required when filter === 'single'
}

```

# Code Demonstration

```js live=true
//without option

const output = normalCaseGenerator('this');

console.log(output); // Outputs 'This'

//with option

const output = normalCaseGenerator('this is a test', {
  filter: 'all',
});

console.log(output); // Outputs 'This Is A Test'

//with option

const output = normalCaseGenerator('this is a test', {
  filter: 'first',
});

console.log(output); // Outputs 'This is a test'

//with option

const output = normalCaseGenerator('this is a test', {
  filter: 'single',
  textToCapitalize: 'test',
});

console.log(output); // Outputs 'this is a Test'
```

Thank you

---
_Source: https://npm.io/package/normal-case-generator · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._