uniformize

Uniformize

Got bored because we should be able to uniformize quickly string without a function, and I made this.

It extends the String Prototype with different methods to uniformize strings and compare them.

Installation

npm install uniformize
bun install uniformize
yarn add uniformize
pnpm add uniformize

Usage

At the root (your index.ts file for example), import the package once to extend the String prototype:

import "uniformize";

Then, you can use it like this :

import "uniformize"; //need to be imported at last one time in your project, for example, in your `index.ts` file
const str = "Je suis écrit en français, avec plein d'accents relou !";
const uniformized = str.standardize();
// uniformized === 'je suis ecrit en francais, avec plein d'accents relou !'

Methods

removeAccents(): string

Removes accents from a string.

Example:

const str = "Café";
const result = str.removeAccents();
console.log(result); // "Cafe"

standardize(noTrim?: boolean): string

Removes accents from a string, standardizes it (lowercase), and optionally trims it.

• noTrim (optional): If true, the string won't be trimmed.

Example:

const str = "  Café au lait  ";
const result = str.standardize();
console.log(result); // "cafe au lait"

toTitle(): string

Capitalizes the first letter of a string.

Example:

const str = "hello world";
const result = str.toTitle();
console.log(result); // "Hello world"

subText(query?: string | null, strict?: boolean): boolean

Searches for a substring within a string, standardizes, trims, and lowercases both the string and the search query.

• query (optional): The substring to search for.
• strict (optional): If true, the search will be a strict equality check, instead of inclusion.

Example:

const str = "Hello World";
const result = str.subText("hello");
console.log(result); // true

capitalize(): string

Capitalizes the first letter of each word in a string.

Example:

const str = "hello world";
const result = str.capitalize();
console.log(result); // "Hello World"

unidecode(keepAccent?: boolean): string

Removes emojis from a string.

• keepAccent (optional): If true, accents will be kept; otherwise, they will be removed along with emojis.

Example:

const str = "Hello 😊";
const result = str.unidecode();
console.log(result); // "Hello "

removeBacktick(): string

Removes backticks from a string.

Example:

const str = "`Hello` World";
const result = str.removeBacktick();
console.log(result); // "Hello World"

Changelog

2.1.0 (2024-11-03)

Features

• capitalize: support uppercase after "-" (a3fa1b9)