StringHelper Class

Static utility helper class for working with strings.

Since v2.0.0

Example

import { StringHelper } from 'vue-mdbootstrap';

const str = 'hello, GOOD morning';
const result = StringHelper.titleCase(str);
// result: Hello, Good Morning

isEndWith

class StringHelper {
  static isEndWith(source?: string, searches?: string[]): boolean;
}

Determines whether a string ends with any of the specified string or not. Returns true if any of the given strings in the collection is found at the end of the string, otherwise false.

Details:

• source: The input string to evaluate.
• searches: Collection of string to search at the end of string.

titleCase

class StringHelper {
  static titleCase(text?: string): string;
}

Simple function to transform the input string into Title Case. Returns new string that has been transform to Title Case.

Details:

• text: The input string to transform

camelCase

class StringHelper {
  static camelCase(text?: string): string;
}

Simple function to transform the input string into camelCase. Returns new string that has been transform to camelCase.

Details:

• text: The input string to transform

kebabCase

class StringHelper {
  static kebabCase(text?: string): string;
}

Simple function to transform the input string into kebab-case. Returns new string that has been transform to kebab-case.

Details:

• text: The input string to transform

padLeft

class StringHelper {
  static padLeft(str: string | number, maxLength?: number, fillString?: string): string;
}

Pads the input string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the start (left) of the input string. Returns new string that has been padded on the left side.

Details:

• str: The string to pad.
• maxLength: The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
• fillString: The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

padRight

class StringHelper {
  static padRight(str: string | number, maxLength?: number, fillString?: string): string;
}

Pads the input string with a given string (possibly repeated) so that the resulting string reaches a given length. The padding is applied from the end (right) of the input string. Returns new string that has been padded on the right side.

Details:

• str: The string to pad.
• maxLength: The length of the resulting string once the current string has been padded. If this parameter is smaller than the current string's length, the current string will be returned as it is.
• fillString: The string to pad the current string with. If this string is too long, it will be truncated and the left-most part will be applied. The default value for this parameter is " " (U+0020).

chunk

class StringHelper {
  static chunk(source: string, size?: number): string[];
}

Create an array of chunked strings. Returns array of chunked strings.

Details:

• source: The input string to be processed.
• size: The number of characters within a chunk.

encodeSpecialChars

class StringHelper {
  static encodeSpecialChars(source: string, excludeDblQuote?: boolean, chars?: string[], replaces?: string[]): string;
}

Replace special characters from the given source with encoded chars.

Double quote will always be encoded to html entity unless excludeDblQuote is set to true.

Details:

• source: The input string to encode.
• excludeDblQuote: Optional, don't convert double quote to html entity.
• chars: Optional, special characters to encode.
• replaces: Optional, the encoded characters or replacement characters for the given chars.