# case-corrector

> - [Description](#description) - [Installation](#installation) - [Usage](#usage) - [API Reference](#api-reference) - [Contributing](#contributing) - [License](#license)

Latest version **1.0.11** (published 2023-10-05) · ISC license · 0 weekly downloads

## Install

```sh
npm install case-corrector
pnpm add case-corrector
yarn add case-corrector
bun add case-corrector
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.11 |
| Published | 2023-10-05 |
| First published | 2023-10-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | onyangoabbey |

## Links

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

## Recent versions

- 1.0.11 (latest) — 2023-10-05
- 1.0.1 — 2023-10-04

## README

# case-corrector

## Table of Contents

- [Description](#description)
- [Installation](#installation)
- [Usage](#usage)
- [API Reference](#api-reference)
- [Contributing](#contributing)
- [License](#license)

## Description

The case-corrector library is a lightweight and efficient JavaScript utility for transforming names into sentence case. Whether you're dealing with user input, data processing, or any scenario where consistent and readable formatting matters, this library simplifies the task of capitalizing the first letter of each word in a name while converting the rest to lowercase.

### Features

- **Simple Integration**: Easily incorporate the case-corrector library into your JavaScript projects with a straightforward API.

- **Efficient and Lightweight**: Designed to minimize runtime impact, this library efficiently processes names, making it suitable for applications of all sizes.

- **Flexible Usage**: Use it to correct names from various sources, such as user inputs, databases, or API responses.

- **Supports Diverse Input**: Handles names with spaces, ensuring that multiple words are correctly formatted.

- **Improved Readability**: Enhance the readability of your text by standardizing the capitalization of names.

## Installation

You can install this library using npm or yarn:

```bash
npm install case-corrector
# or
yarn add case-corrector
```

## Usage

```
const caseCorrector = require("case-corrector");

const inputName = "OnYanGo AbBeY";
const correctedCase = caseCorrector(inputName);
console.log(correctedCase); // Output: "Onyango Abbey"
```

## API Reference

`correctedCase(name: string): string`

Example

```javascript
const caseCorrector = require('case-corrector');
const inputName = "OnYanGo AbBeY";
const correctedCase = case-corrector.toSentenceCase(inputName);
console.log(correctedCase); // Output: "Onyango Abbey"

```

## Contributing

```javascript
If you'd like to contribute to this library, please follow these guidelines:

Fork the repository on GitHub.
Make your changes in a feature branch.
Write tests for your changes (if applicable).
Make sure all tests pass.
Submit a pull request with a clear description of your changes.
```

## License

---

```javascript
This project is licensed under the [MIT License](LICENSE.md). You are free to use, modify, and distribute this library as per the terms of the license.
```

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