@plandek-utils/ts-clean-key

!CI

TypeDoc generated docs in here

Github repo here

Removes bad chars for a string key (all except number 0-9, lowercase ascii7 letters a-z, dash - and underscore _).

It also removes multiple dashes in a row and replaces them for a single dash, which can be optionally disabled.

It can optionally also allow uppercase ascii7 letters A-Z with a toggle.

It can optionally also allow extra characters, like dots or other special characters, by using a mode option.

Installation

``bash
npm install @plandek-utils/ts-clean-key
`

Usage

`typescript
import { cleanKey } from "@plandek-utils/ts-clean-key";

cleanKey(""); // => ""
cleanKey(" a - b"); // => "a-b"
cleanKey(" some Stuff 🚀 \n ñaaa --- a"); // => "sometuffaaa-a"
`

$3

First it trims and parameterizes the original string (using the parameterize package), and then it cleans it using the cleanKey function

`typescript
import { parameterizeAndClean } from "@plandek-utils/ts-clean-key";

parameterizeAndClean(""); // ""
parameterizeAndClean(" a - b "); // "a-b"
parameterizeAndClean(" parameterized url with special characters, öçıŞÇ "); // "parameterized-url-with-special-characters-ocisc"
parameterizeAndClean(" |/~ ", { prependIfNoLetters: "S.tu" }); // "tu"
`

$3

By default, cleanKey will replace many resulting dashes for a single dash. You can disable this behaviour by passing replaceManyDashes: false in the optional options argument, or by using the cleanKeySimple() function.

`typescript
import { cleanKey, cleanKeySimple } from "@plandek-utils/ts-clean-key";

cleanKey(" something-is---here "); // => "something-is-here"
cleanKey(" something-is---here ", { replaceManyDashes: false }); // => "something-is---here"
cleanKeySimple(" something-is---here "); // => "something-is---here"
`

$3

With the option trimEdgeDashes: true, cleanKey will remove any dash - at the beginning or end of the clean key.

`typescript
import { cleanKey } from "@plandek-utils/ts-clean-key";

cleanKey(" -something-is---here-"); // => "-something-is-here-"
cleanKey(" -something-is---here-", { trimEdgeDashes: false }); // => "-something-is-here-"
cleanKey(" -something-is---here-", { trimEdgeDashes: true }); // => "something-is-here"
`

$3

If in the resulting key no letters a-z or A-Z are found, and the option prependIfNoLetters is given, it will prepend it to the original string, and clean again. Notice that the string passed to be prepended will also be cleaned. It has no effect if the resulting key contains letters.

`typescript
import { cleanKey, cleanKeySimple } from "@plandek-utils/ts-clean-key";

cleanKey(" 1 - 2 "); // => "1-2"
cleanKey(" 1 - 2", { prependIfNoLetters: "S.tu " }); // => "tu1-2"
cleanKey(" a - 2", { prependIfNoLetters: "S.tu " }); // => "a-2"
`

$3

By default, cleanKey will not allow uppercase ascii7 letters A-Z. You can change this behaviour by passing caseSensitive: false in the optional second argument, or by using the cleanKeyCI() or cleanKeySimpleCI() functions

`typescript
import { cleanKey, cleanKeyCI, cleanKeySimpleCI } from "@plandek-utils/ts-clean-key";

cleanKey(" Remove---Me "); // => "emove-e"
cleanKey(" Remove---Me ", { caseSensitive: false }); // => "Remove-Me"
cleanKeyCI(" Remove---Me "); // => "Remove-Me"

cleanKey(" Remove---Me ", { replaceManyDashes: false }); // => "emove---e"
cleanKey(" Remove---Me ", { replaceManyDashes: false, caseSensitive: false }); // => "Remove---Me"
cleanKeySimpleCI(" Remove---Me "); // => "Remove---Me"
`

$3

By default, cleanKey will not allow dots .. You can change this behaviour by passing mode: CharAllowanceMode.Dots (or mode: "dots") in the optional second argument, or by using the cleanKeyCIWithDots(), cleanKeyWithDots(), cleanKeySimpleWithDot()orcleanKeySimpleCIWithDots() functions.

``typescript
import {
cleanKey,
cleanKeyCI,
cleanKeySimpleWithDots,
cleanKeySimpleCIWithDots,
cleanKeyWithDots,
CharAllowanceMode,
} from "@plandek-utils/ts-clean-key";

cleanKey(" Re.|~:/m#ove---Me "); // => "emove-e"

cleanKey(" Re.|~:/m#ove---Me ", { mode: CharAllowanceMode.Dots }); // => "e.move-e"
cleanKeyWithDots(" Re.|~:/m#ove---Me "); // => "e.move-e"

cleanKey(" Re.|~:/m#ove---Me ", { caseSensitive: false, mode: CharAllowanceMode.Dots }); // => "Re.move-Me"
cleanKeyWithDots(" Re.|~:/m#ove---Me ", { caseSensitive: false }); // => "Re.move-Me"
cleanKeyCI(" Re.|~:/m#ove---Me ", { mode: CharAllowanceMode.Dots }); // => "Re.move-Me"

cleanKey(" Re.|~:/m#ove---Me ", { replaceManyDashes: false, mode: CharAllowanceMode.Dots }); // => "e.move---e"
cleanKeyWithDots(" Re.|~:/m#ove---Me ", { replaceManyDashes: false }); // => "e.move---e"
cleanKeySimpleWithDots(" Re.|~:/m#ove---Me "); // => "e.move---e"

cleanKey(" Re.|~:/m#ove---Me ", { caseSensitive: false, mode: CharAllowanceMode.Dots, replaceManyDashes: false }); // => "Re.move---Me"
cleanKeyWithDots(" Re.|~:/m#ove---Me ", { caseSensitive: false, replaceManyDashes: false }); // => "Re.move---Me"
cleanKeyCI(" Re.|~:/m#ove---Me ", { mode: CharAllowanceMode.Dots, replaceManyDashes: false }); // => "Re.move---Me"
cleanKeySimpleCIWithDots(" Re.|~:/m#ove---Me "); // => "Re.move---Me"
`

$3

Similar to the dots mode, but allowing also pipes |, colons :, and slashes /.
You can change this behaviour by passing mode: CharAllowanceMode.Specials (or mode: "specials") in the optional second argument, or by using the cleanKeyCIWithSpecials(), cleanKeyWithSpecials(), cleanKeySimpleWithDot()orcleanKeySimpleCIWithSpecials() functions.

``typescript
import {
cleanKey,
cleanKeyCI,
cleanKeySimpleWithSpecials,
cleanKeySimpleCIWithSpecials,
cleanKeyWithSpecials,
CharAllowanceMode,
} from "@plandek-utils/ts-clean-key";

cleanKey(" Re.|~:/m#ove---Me "); // => "emove-e"

cleanKey(" Re.|~:/m#ove---Me ", { mode: CharAllowanceMode.Specials }); // => "e.|~:/m#ove-e"
cleanKeyWithSpecials(" Re.|~:/m#ove---Me "); // => "e.|~:/m#ove-e"

cleanKey(" Re.|~:/m#ove---Me ", { caseSensitive: false, mode: CharAllowanceMode.Specials }); // => "Re.|~:/m#ove-Me"
cleanKeyWithSpecials(" Re.|~:/m#ove---Me ", { caseSensitive: false }); // => "Re.|~:/m#ove-Me"
cleanKeyCI(" Re.|~:/m#ove---Me ", { mode: CharAllowanceMode.Specials }); // => "Re.|~:/m#ove-Me"

cleanKey(" Re.|~:/m#ove---Me ", { replaceManyDashes: false, mode: CharAllowanceMode.Specials }); // => "e.|~:/m#ove---e"
cleanKeyWithSpecials(" Re.|~:/m#ove---Me ", { replaceManyDashes: false }); // => "e.|~:/m#ove---e"
cleanKeySimpleWithSpecials(" Re.|~:/m#ove---Me "); // => "e.|~:/m#ove---e"

cleanKey(" Re.|~:/m#ove---Me ", { caseSensitive: false, mode: CharAllowanceMode.Specials, replaceManyDashes: false }); // => "Re.|~:/m#ove---Me"
cleanKeyWithSpecials(" Re.|~:/m#ove---Me ", { caseSensitive: false, replaceManyDashes: false }); // => "Re.|~:/m#ove---Me"
cleanKeyCI(" Re.|~:/m#ove---Me ", { mode: CharAllowanceMode.Specials, replaceManyDashes: false }); // => "Re.|~:/m#ove---Me"
cleanKeySimpleCIWithSpecials(" Re.|~:/m#ove---Me "); // => "Re.|~:/m#ove---Me"
`

processedSafeKey

This function returns a special way of cleaning keys: For each character in the string that is not one of the safe characters [a-zA-Z0-9], it will replace them with -HEX_UNICODE_CODE_PADDED_6 (e.g. ' ' => '-000020').

`typescript
processedSafeKey("casa"); // => "casa"
processedSafeKey("casa de/paco"); // => "casa-000020de-00002Fpaco");
`

safeKeyToOriginal

Inverse to processedSafeKey, this function will replace the -HEX_UNICODE_CODE_PADDED_6 with the original character.

`typescript
safeKeyToOriginal("casa"); // => "casa"
safeKeyToOriginal("casa-000020de-00002Fpaco"); // => "casa de/paco");
`

escapeTemplateString

This function escapes the characters of a template string following the rules of amCharts text styling. It replaces curly braces { with {{ and } with }}, and square brackets [ with [[ and ] with ]].

Warning: This function is not repeatable, meaning you cannot apply it several times to the same string. For example, if you apply it once to {hello}, you get {{hello}}, and if you apply it again, you get {{{{hello}}}}.

`typescript
import { escapeTemplateString } from "@plandek-utils/ts-clean-key";

escapeTemplateString("{hello}"); // => "{{hello}}"
escapeTemplateString("[world]"); // => "[[world]]"
escapeTemplateString("{hello [world]}"); // => "{{hello [[world]]}}"
escapeTemplateString("hello world"); // => "hello world"
`

Breaking changes warning

$3

Since v5.0 the specials option includes the hashtag character #.

$3

Since v4.0 the specials option includes the tilde character ~.

$3

Since v3.0 the allowedDots option was replaced with a mode option that can be strict (default), dots, or specials. The typescript CharAllowanceMode enum covers the possible modes.

$3

Since v2.0 the cleanKey is not the default export. Instead both cleanKey and cleanKeySimple are named exports.

`typescript
// v1.x
import cleanKey from "@plandek-utils/ts-clean-key";

// v2.x
import { cleanKey } from "@plandek-utils/ts-clean-key";
``