Files
Website/resources/js/helpers/string.ts
2023-02-28 19:16:10 +10:00

118 lines
3.0 KiB
TypeScript

/**
* Transforms a string to title case.
*
* @param {string} str The string to transform.
* @returns {string} A string transformed to title case.
*/
export const toTitleCase = (str: string): string => {
return str.replace(/\w\S*/g, function (txt) {
return (
txt.charAt(0).toUpperCase() +
txt.substring(1).replace(/_/g, " ").toLowerCase()
);
});
};
/**
* Convert a string to a excerpt.
*
* @param {string} txt The text to convert.
* @param {number} maxLen (optional) The maximum length of the excerpt.
* @param {boolean} strip (optional) Strip HTML tags from the text.
* @param stripHtml
* @returns {string} The excerpt.
*/
export const excerpt = (
txt: string,
maxLen: number = 150,
stripHtml: boolean = true
): string => {
if (stripHtml) {
txt = stripHtmlTags(replaceHtmlEntites(txt));
}
const txtPieces = txt.split(" ");
const excerptPieces: string[] = [];
let curLen = 0;
txtPieces.every((itm) => {
if (curLen + itm.length >= maxLen) {
return false;
}
excerptPieces.push(itm);
curLen += itm.length + 1;
return true;
});
return excerptPieces.join(" ") + (curLen < txt.length ? "..." : "");
};
/**
* String HTML tags from text.
*
* @param {string} txt The text to strip tags.
* @returns {string} The stripped text.
*/
export const stripHtmlTags = (txt: string): string => {
txt = txt.replace(/<(p|br)([ /]*?>|[ /]+.*?>)/g, " ");
return txt.replace(/<[a-zA-Z/][^>]+(>|$)/g, "");
};
/**
* Replace HTML entities with real characters.
*
* @param {string} txt The text to transform.
* @returns {string} Transformed text
*/
export const replaceHtmlEntites = (txt: string): string => {
const translate_re = /&(nbsp|amp|quot|lt|gt);/g;
const translate = {
nbsp: " ",
amp: "&",
quot: '"',
lt: "<",
gt: ">",
};
return txt.replace(translate_re, function (match, entity) {
return translate[entity];
});
};
/**
* Convert a string to a number, ignoring items like dollar signs, etc.
*
* @param {string} str The string to convert to a number
* @returns {number} A number with the minimum amount of decimal places (or 0)
*/
export const stringToNumber = (str: string): number => {
str = str.replace(/[^\d.-]/g, "");
const num = Number.parseFloat(str);
return isNaN(num) ? 0 : parseFloat(num.toFixed(2));
};
/**
* Convert a number or string to a price (0 or 0.00).
*
* @param {number|string} numOrString The number of string to convert to a price.
* @returns {string} The converted result.
*/
export const toPrice = (numOrString: number | string): string => {
let num = 0;
if (typeof numOrString == "string") {
num = stringToNumber(numOrString);
} else {
num = numOrString;
}
if (num % 1 === 0) {
// Number has no decimal places
return num.toFixed(0);
} else {
// Number has decimal places
return num.toFixed(2);
}
};