Module string

Functions

Functions

stringClearReferences

stringClearReferences(text: string): string

- Defined in string/clear/references.ts:1
Parameters
- text: string
Returns string

stringFindMatch

stringFindMatch(needle: string, haystack: string[]): object

- Defined in string/find/match.ts:3
Parameters
- needle: string
- haystack: string[]
Returns object
- bestMatch: string
- bestMatchIndex: number
- ratings: object[]

stringFindSimilarity

stringFindSimilarity(alpha: string, beta: string): number

- Defined in string/find/similarity.ts:1
Parameters
- alpha: string
- beta: string
Returns number

stringFindSub

stringFindSub(text?: string, begin?: number, end?: number): string

- Defined in string/find/sub.ts:8
Returns a section of a string.

Parameters
- text: string = ""
- begin: number = 0
- Optional end: number
Returns string

stringGetCount

stringGetCount(text: string): number

- Defined in string/get/count.ts:7
name

stringGetCount

description

Get count of symbols in text. This is not string length.

Parameters
- text: string
  
  The string being measured for length.
Returns number

stringIsComparable

stringIsComparable(first: string, second: string, isStrict?: boolean): boolean

- Defined in string/is/comparable.ts:11
Compare two strings

Parameters
- first: string
- second: string
- isStrict: boolean = false
Returns boolean

stringIsContain

stringIsContain(haystack: string, needle: string, isStrict?: boolean): boolean

- Defined in string/is/contain.ts:11
Perform search in string

Parameters
- haystack: string
- needle: string
- isStrict: boolean = false
Returns boolean

stringIsSimilar

stringIsSimilar(alpha: string, beta: string, minRating?: number): boolean

- Defined in string/is/similar.ts:14
Finds degree of similarity between two strings using Sørensen–Dice coefficient

Parameters
- alpha: string
- beta: string
- minRating: number = 0.85
Returns boolean

stringMakeEscaped

stringMakeEscaped(text: string): string

- Defined in string/make/escaped.ts:3
Parameters
- text: string
Returns string

stringMakeReversed

stringMakeReversed(text: string): string

- Defined in string/make/reversed.ts:7
name

stringMakeReversed

description

Reverse string

since

0.1.32

Parameters
- text: string
Returns string

Reversed string

Generated using TypeDoc