@zerodep/string-deburr
v2.0.11
Published
A utility to convert accented characters to non-accented equivalents
Downloads
373
Readme
@zerodep/string-deburr
A utility to convert accented characters to their equivalent ASCII values. Non-string values will cause a ZeroDepError
to be thrown.
Full documentation is available at the zerodep.app page.
Signature
declare const stringDeburr: (value: string) => string;
Examples
All @zerodep packages support both ESM and CJS formats, each complete with Typescript typings.
// ESM
import { stringDeburr } from '@zerodep/string-deburr';
// CJS
const { stringDeburr } = require('@zerodep/string-deburr');
// with accented strings
stringDeburr('àëîóüý Žøñç'); // "aeiouy Zonc"
stringDeburr('Hello There!ç'); // "Hello There!c"
// with regular ascii characters
stringDeburr('Testing 1234 !@#$%'); // "Testing 1234 !@#$%"
// with anything that is not a string
stringDeburr({ a: 'not string' }); // throws ZeroDepError: Value is not a string
ZeroDep Advantages
- Zero npm dependencies - completely eliminates all risk of supply-chain attacks, decreases node_modules folder size
- ESM & CJS - has both ecmascript modules and common javascript exports
- Tree Shakable - built to be fully tree shakable ensuring your packages are the smallest possible size
- Fully typed - typescript definitions are provided for every package for a better developer experience
- Semantically named - package and method names are easy to grok, remember, use, and read
- Documented - actually useful documentation with examples at zerodep.app
- Intelligently Packaged - multiple npm packages of different sizes available allowing a menu or a-la-carte composition of capabilities
- 100% Tested - all methods and packages are fully unit tested
- Predictably Versioned - semantically versioned for peace-of-mind upgrading, this includes changelogs
- MIT Licensed - permissively licensed for maximum usability