Module src/string

Index

Interfaces

StringIndexable

Type aliases

Functions

Type aliases

ClassNamesArray

ClassNamesArray: (string | StringIndexable | (string | StringIndexable)[])[]

NestedClassNamesArray

NestedClassNamesArray: (string | StringIndexable | ClassNamesArray)[]

Functions

Const classNames

classNames(...args: NestedClassNamesArray): string

- Defined in src/string/classNames.ts:17
Returns a single string of class names to add to HTML elements.

Implementation and tests adapted from https://www.npmjs.com/package/classnames. This helper was built to replace our reliance on this dependency.

Parameters
- Rest ...args: NestedClassNamesArray
  
  List of class names to concatenate.
Returns string

The concantenated classnames.

Const isString

isString(valueToCheck: unknown): valueToCheck is string

- Defined in src/string/isString.ts:7
description

Checks whether the value provided is of type string

Parameters
- valueToCheck: unknown
  
  The value we are checking is a string
Returns valueToCheck is string

Type casting if the value is a string

Const replaceAllInString

replaceAllInString(str: string, replacements: Record<string, string>): string

- Defined in src/string/replaceAllInString.ts:10
description

Searches a string and replaces matching strings with another value

see

Inspiration Taken from here https://stackoverflow.com/questions/5069464/replace-multiple-strings-at-once/34560648#34560648 and modified

Parameters
- str: string
  
  String with keys that match the props in replacements
- replacements: Record<string, string>
  
  Data to replace matching keys in str
Returns string

str with replacements

Const stripEscapedWords

stripEscapedWords(value: string): string

- Defined in src/string/stripEscapedWords.ts:7
description

Remove escaped words from a string

Parameters
- value: string
  
  The value to strip escaped words from
Returns string

the value without escaped words

Generated using TypeDoc