match-casing

Match the case of value to that of base.

What is this?
When should I use this?
Install
Use
API
- matchCasing(value, base)
Algorithm
Types
Compatibility
Security
Related
Contribute
License

What is this?

This package matches the case (lowercase, uppercase, capitalized) of a string to that of another string.

When should I use this?

This package is useful if a user wrote some word, and you want to suggest a replacement, and want to make sure that the suggestion matches that of the original.

Install

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

npm install match-casing

In Deno with esm.sh:

import {matchCasing} from 'https://esm.sh/match-casing@2'

In browsers with esm.sh:

<script type="module">
  import {matchCasing} from 'https://esm.sh/match-casing@2?bundle'
</script>

Use

import {matchCasing} from 'match-casing'

matchCasing('foo', 'BAZ') // => 'FOO'
matchCasing('foo', 'Baz') // => 'Foo'
matchCasing('foo', 'baz') // => 'foo'
matchCasing('foo', 'BaZ') // => 'foo'

matchCasing('FOO', 'BAZ') // => 'FOO'
matchCasing('FOO', 'Baz') // => 'Foo'
matchCasing('FOO', 'baz') // => 'foo'
matchCasing('FOO', 'BaZ') // => 'FOO'

matchCasing('Foo', 'BAZ') // => 'FOO'
matchCasing('Foo', 'Baz') // => 'Foo'
matchCasing('Foo', 'baz') // => 'foo'
matchCasing('Foo', 'BaZ') // => 'Foo'

matchCasing('’90S', '’twas') // => '’90s'
matchCasing('’N’', 'a') // => '’n’'

API

This package exports the identifier matchCasing. There is no default export.

`matchCasing(value, base)`

Transform the case in value (string) to match that of base (string).

Algorithm

if base is uppercase, value is uppercased
else, if base is lowercase, value is lowercased
else, if the first alphabetic character in base is uppercase, and the rest of base is lowercase, uppercase the first alphabetic character in value and lowercase the rest
else, return value unmodified

The third case deals with initial non-alphabetical characters as expected.

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

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

Security

This package is safe.

words/emoji-emotion — list of emoji rated for valence
wooorm/emoticon — info on ASCII emoticons
wooorm/strip-skin-tone — strip skin-tones from emoji
wooorm.com/checkmoji — check emoji across platforms

Contribute

Yes please! See How to Contribute to Open Source.

wooorm/match-casing