Utils: `strings`
Table of contents
Enumerations
Type Aliases
Variables
Functions
- contains
- containsFP
- endsWith
- endsWithFP
- firstToLower
- firstToUpper
- getFirstChar
- getWordParts
- isAlpha
- isAlphaNumeric
- isBase64
- isCountryCode
- isEmail
- isFQDN
- isMACAddress
- isMACAddressFP
- isMIMEType
- isPort
- isPostalCode
- isPrimitiveValue
- isString
- isURL
- isUUID
- joinList
- parseList
- primitiveToString
- shannonEntropy
- startsWith
- startsWithFP
- stringEntropy
- toCamelCase
- toKebabCase
- toLowerCase
- toPascalCase
- toSafeString
- toSnakeCase
- toString
- toTitleCase
- toUpperCase
- trim
- trimAndToLower
- trimAndToUpper
- trimEnd
- trimEndFP
- trimFP
- trimStart
- trimStartFP
- truncate
- truncateFP
- unescapeString
Type Aliases
StringEntropyFN
Ƭ StringEntropyFN: (input
: unknown
) => number
Type declaration
▸ (input
): number
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/strings.ts:612
Variables
LOWER_CASE_CHARS
• Const
LOWER_CASE_CHARS: Object
Type declaration
Name | Type |
---|---|
a | true |
b | true |
c | true |
d | true |
e | true |
f | true |
g | true |
h | true |
i | true |
j | true |
k | true |
l | true |
m | true |
n | true |
o | true |
p | true |
q | true |
r | true |
s | true |
t | true |
u | true |
v | true |
w | true |
x | true |
y | true |
z | true |
Defined in
packages/utils/src/strings.ts:254
NUM_CHARS
• Const
NUM_CHARS: Object
Type declaration
Name | Type |
---|---|
0 | true |
1 | true |
2 | true |
3 | true |
4 | true |
5 | true |
6 | true |
7 | true |
8 | true |
9 | true |
Defined in
packages/utils/src/strings.ts:312
UPPER_CASE_CHARS
• Const
UPPER_CASE_CHARS: Object
Type declaration
Name | Type |
---|---|
A | true |
B | true |
C | true |
D | true |
E | true |
F | true |
G | true |
H | true |
I | true |
J | true |
K | true |
L | true |
M | true |
N | true |
O | true |
P | true |
Q | true |
R | true |
S | true |
T | true |
U | true |
V | true |
W | true |
X | true |
Y | true |
Z | true |
Defined in
packages/utils/src/strings.ts:283
WORD_CHARS
• Const
WORD_CHARS: Object
Type declaration
Name | Type |
---|---|
0 | true |
1 | true |
2 | true |
3 | true |
4 | true |
5 | true |
6 | true |
7 | true |
8 | true |
9 | true |
A | true |
B | true |
C | true |
D | true |
E | true |
F | true |
G | true |
H | true |
I | true |
J | true |
K | true |
L | true |
M | true |
N | true |
O | true |
P | true |
Q | true |
R | true |
S | true |
T | true |
U | true |
V | true |
W | true |
X | true |
Y | true |
Z | true |
a | true |
b | true |
c | true |
d | true |
e | true |
f | true |
g | true |
h | true |
i | true |
j | true |
k | true |
l | true |
m | true |
n | true |
o | true |
p | true |
q | true |
r | true |
s | true |
t | true |
u | true |
v | true |
w | true |
x | true |
y | true |
z | true |
Defined in
packages/utils/src/strings.ts:331
WORD_SEPARATOR_CHARS
• Const
WORD_SEPARATOR_CHARS: Object
Type declaration
Name | Type |
---|---|
| true |
- | true |
_ | true |
Defined in
packages/utils/src/strings.ts:325
Functions
contains
▸ contains(input
, substring
): input is string
Check whether a string includes another string
Parameters
Name | Type |
---|---|
input | unknown |
substring | string |
Returns
input is string
Defined in
packages/utils/src/strings.ts:501
containsFP
▸ containsFP(substring
): (input
: unknown
) => input is string
A function version of contains
Parameters
Name | Type |
---|---|
substring | string |
Returns
fn
▸ (input
): input is string
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is string
Defined in
packages/utils/src/strings.ts:508
endsWith
▸ endsWith(str
, val
): boolean
A native implementation of lodash endsWith
Parameters
Name | Type |
---|---|
str | unknown |
val | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:213
endsWithFP
▸ endsWithFP(val
): (input
: unknown
) => boolean
A function version of startsWith
Parameters
Name | Type |
---|---|
val | string |
Returns
fn
▸ (input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:221
firstToLower
▸ firstToLower(str
): string
Change first character in string to lower case
Parameters
Name | Type |
---|---|
str | string |
Returns
string
Defined in
packages/utils/src/strings.ts:443
firstToUpper
▸ firstToUpper(str
): string
Change first character in string to upper case
Parameters
Name | Type |
---|---|
str | string |
Returns
string
Defined in
packages/utils/src/strings.ts:437
getFirstChar
▸ getFirstChar(input
): string
Parameters
Name | Type |
---|---|
input | string |
Returns
string
Defined in
packages/utils/src/strings.ts:448
getWordParts
▸ getWordParts(input
): string
[]
Split a string and get the word parts
Parameters
Name | Type |
---|---|
input | string |
Returns
string
[]
Defined in
packages/utils/src/strings.ts:340
isAlpha
▸ isAlpha(input
, locale?
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
locale? | AlphaLocale |
Returns
boolean
Defined in
packages/utils/src/strings.ts:545
isAlphaNumeric
▸ isAlphaNumeric(input
, locale?
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
locale? | AlphanumericLocale |
Returns
boolean
Defined in
packages/utils/src/strings.ts:549
isBase64
▸ isBase64(input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:514
isCountryCode
▸ isCountryCode(input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:533
isEmail
▸ isEmail(input
): input is string
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is string
Defined in
packages/utils/src/strings.ts:457
isFQDN
▸ isFQDN(input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:529
isMACAddress
▸ isMACAddress(input
, delimiter?
): input is string
Parameters
Name | Type |
---|---|
input | unknown |
delimiter? | MACDelimiter |
Returns
input is string
Defined in
packages/utils/src/strings.ts:469
isMACAddressFP
▸ isMACAddressFP(args?
): (input
: unknown
) => input is string
A functional version of isMacAddress
Parameters
Name | Type |
---|---|
args? | MACDelimiter |
Returns
fn
▸ (input
): input is string
Parameters
Name | Type |
---|---|
input | unknown |
Returns
input is string
Defined in
packages/utils/src/strings.ts:484
isMIMEType
▸ isMIMEType(input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:553
isPort
▸ isPort(input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:541
isPostalCode
▸ isPostalCode(input
, locale?
): boolean
Parameters
Name | Type | Default value | |
---|---|---|---|
input | unknown | undefined | |
locale | "any" \ | PostalCodeLocale | 'any' |
Returns
boolean
Defined in
packages/utils/src/strings.ts:537
isPrimitiveValue
▸ isPrimitiveValue(value
): boolean
Check if a value is a JavaScript primitive value OR it is object with Symbol.toPrimitive
Parameters
Name | Type |
---|---|
value | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:83
isString
▸ isString(val
): val is string
A simplified implementation of lodash isString
Parameters
Name | Type |
---|---|
val | unknown |
Returns
val is string
Defined in
packages/utils/src/strings.ts:15
isURL
▸ isURL(input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:490
isUUID
▸ isUUID(input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:494
joinList
▸ joinList(input
, sep?
, join?
): string
Create a sentence from a list (all items will be unique, empty values will be skipped)
Parameters
Name | Type | Default value | |
---|---|---|---|
input | JoinListType [] \ | readonly JoinListType [] | undefined |
sep | string | ',' | |
join | string | 'and' |
Returns
string
Defined in
packages/utils/src/strings.ts:582
parseList
▸ parseList(input
): string
[]
Maps an array of strings and and trims the result, or parses a comma separated list and trims the result
Parameters
Name | Type |
---|---|
input | unknown |
Returns
string
[]
Defined in
packages/utils/src/strings.ts:561
primitiveToString
▸ primitiveToString(value
): string
Convert a JavaScript primitive value to a string. (Does not covert object like entities unless Symbol.toPrimitive is specified)
Parameters
Name | Type |
---|---|
value | unknown |
Returns
string
Defined in
packages/utils/src/strings.ts:98
shannonEntropy
▸ shannonEntropy(input
): number
Performs a Shannon entropy calculation on string inputs
Parameters
Name | Type |
---|---|
input | unknown |
Returns
number
Defined in
packages/utils/src/strings.ts:616
startsWith
▸ startsWith(str
, val
): boolean
A native implementation of lodash startsWith
Parameters
Name | Type |
---|---|
str | unknown |
val | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:195
startsWithFP
▸ startsWithFP(val
): (input
: unknown
) => boolean
A function version of startsWith
Parameters
Name | Type |
---|---|
val | string |
Returns
fn
▸ (input
): boolean
Parameters
Name | Type |
---|---|
input | unknown |
Returns
boolean
Defined in
packages/utils/src/strings.ts:203
stringEntropy
▸ stringEntropy(algo?
): StringEntropyFN
returns a function to perform entropy calculations, currently only supports the "shannon" algorithm
Parameters
Name | Type | Default value |
---|---|---|
algo | shannon | StringEntropy.shannon |
Returns
Defined in
packages/utils/src/strings.ts:654
toCamelCase
▸ toCamelCase(input
): string
Parameters
Name | Type |
---|---|
input | string |
Returns
string
Defined in
packages/utils/src/strings.ts:384
toKebabCase
▸ toKebabCase(input
): string
Parameters
Name | Type |
---|---|
input | string |
Returns
string
Defined in
packages/utils/src/strings.ts:392
toLowerCase
▸ toLowerCase(input
): string
Converts a value to lower case
Parameters
Name | Type |
---|---|
input | unknown |
Returns
string
Example
toLowerCase('lowercase'); // 'lowercase'
toLowerCase('MixEd'); // 'mixed'
toLowerCase('UPPERCASE'); // 'uppercase'
Defined in
packages/utils/src/strings.ts:170
toPascalCase
▸ toPascalCase(input
): string
Parameters
Name | Type |
---|---|
input | string |
Returns
string
Defined in
packages/utils/src/strings.ts:388
toSafeString
▸ toSafeString(input
): string
Make a string url/elasticsearch safe. safeString converts the string to lower case, removes any invalid characters, and replaces whitespace with _ (if it exists in the string) or - Warning this may reduce the str length
Parameters
Name | Type |
---|---|
input | string |
Returns
string
Defined in
packages/utils/src/strings.ts:411
toSnakeCase
▸ toSnakeCase(input
): string
Parameters
Name | Type |
---|---|
input | string |
Returns
string
Defined in
packages/utils/src/strings.ts:396
toString
▸ toString(val
): string
Safely convert any input to a string
Parameters
Name | Type |
---|---|
val | unknown |
Returns
string
Example
toString(1); // '1'
toString(0.01); // '0.01'
toString(true); // 'true'
toString(BigInt(2) ** BigInt(64)); // '18,446,744,073,709,551,616'
toString(new Date('2020-09-23T14:54:21.020Z')) // '2020-09-23T14:54:21.020Z'
Defined in
packages/utils/src/strings.ts:30
toTitleCase
▸ toTitleCase(input
): string
Parameters
Name | Type |
---|---|
input | string |
Returns
string
Defined in
packages/utils/src/strings.ts:400
toUpperCase
▸ toUpperCase(input
): string
Converts a value to upper case
Parameters
Name | Type |
---|---|
input | unknown |
Returns
string
Example
toUpperCase('lowercase'); // 'LOWERCASE'
toUpperCase('MixEd'); // 'MIXED'
toUpperCase('UPPERCASE'); // 'UPPERCASE'
Defined in
packages/utils/src/strings.ts:156
trim
▸ trim(input
, char?
): string
safely trims whitespace from an input
Parameters
Name | Type |
---|---|
input | unknown |
char? | string |
Returns
string
Defined in
packages/utils/src/strings.ts:107
trimAndToLower
▸ trimAndToLower(input?
): string
safely trim and to lower a input, useful for string comparison
Parameters
Name | Type |
---|---|
input? | string |
Returns
string
Defined in
packages/utils/src/strings.ts:138
trimAndToUpper
▸ trimAndToUpper(input?
): string
safely trim and to lower a input, useful for string comparison
Parameters
Name | Type |
---|---|
input? | string |
Returns
string
Defined in
packages/utils/src/strings.ts:143
trimEnd
▸ trimEnd(input
, char?
): string
Parameters
Name | Type |
---|---|
input | unknown |
char? | string |
Returns
string
Defined in
packages/utils/src/strings.ts:127
trimEndFP
▸ trimEndFP(char?
): (input
: unknown
) => string
Parameters
Name | Type |
---|---|
char? | string |
Returns
fn
▸ (input
): string
Parameters
Name | Type |
---|---|
input | unknown |
Returns
string
Defined in
packages/utils/src/strings.ts:131
trimFP
▸ trimFP(char?
): (input
: unknown
) => string
Parameters
Name | Type |
---|---|
char? | string |
Returns
fn
▸ (input
): string
Parameters
Name | Type |
---|---|
input | unknown |
Returns
string
Defined in
packages/utils/src/strings.ts:111
trimStart
▸ trimStart(input
, char?
): string
Parameters
Name | Type |
---|---|
input | unknown |
char? | string |
Returns
string
Defined in
packages/utils/src/strings.ts:117
trimStartFP
▸ trimStartFP(char?
): (input
: unknown
) => string
Parameters
Name | Type |
---|---|
char? | string |
Returns
fn
▸ (input
): string
Parameters
Name | Type |
---|---|
input | unknown |
Returns
string
Defined in
packages/utils/src/strings.ts:121
truncate
▸ truncate(value
, len
, ellipsis?
): string
Truncate a string value, by default it will add an ellipsis (...) if truncated.
Parameters
Name | Type | Default value |
---|---|---|
value | unknown | undefined |
len | number | undefined |
ellipsis | boolean | true |
Returns
string
Defined in
packages/utils/src/strings.ts:233
truncateFP
▸ truncateFP(len
, ellipsis?
): (value
: unknown
) => string
A functional version of truncate
Parameters
Name | Type | Default value |
---|---|---|
len | number | undefined |
ellipsis | boolean | true |
Returns
fn
▸ (value
): string
Parameters
Name | Type |
---|---|
value | unknown |
Returns
string
Defined in
packages/utils/src/strings.ts:248
unescapeString
▸ unescapeString(str?
): string
Unescape characters in string and avoid double escaping
Parameters
Name | Type | Default value |
---|---|---|
str | string | '' |
Returns
string