@selenite/commons/dist/utils/string.d.ts

This typescript package provides a set of frequently used utilities, types and svelte actions for building projects with Typescript and Svelte.

/**
 * String utils for common string manipulation.
 *
 * Examples are {@link capitalize} and {@link splitCamelCase}....
 * @module
 */
import 'core-js/actual/set/intersection';
import pluralizePackage from 'pluralize';
declare const pluralize: typeof pluralizePackage;
declare const singular: typeof pluralizePackage.singular, isPlural: typeof pluralizePackage.isPlural, isSingular: typeof pluralizePackage.isSingular, plural: typeof pluralizePackage.plural;
export { singular, isPlural, isSingular, plural, pluralize };
export declare function capitalize(str: string): string;
export declare function capitalizeWords(str: string): string;
export declare function isAlphaNumChar(str: string): boolean;
export declare const words: typeof capitalizeWords;
export declare function titlelize(str: string): string;
export declare function initials(str: string): string;
/** Transforms a string into CamelCase. */
export declare function camlelcaseize(str: string): string;
/** Transforms a Camelcase string into a normal space seperated string. */
export declare function unCamelCase(str: string): string;
/**
 * Splits a camel case string into an array of words.
 * @param str Camel case string to split.
 * @returns Array of words.
 */
export declare function splitCamelCase(str: string): string[];
/**
 * Turns an array of strings into an array of their shared words.
 * @param strings
 */
export declare function getSharedWords(strings: string[]): string[];
/**
 * Turns an words of strings into an array of their shared words.
 * @param stringsWords
 */
export declare function getSharedWords(stringsWords: string[][]): string[];
export declare function getSharedString(strings: string[] | string[][], options?: {
    camelcase?: boolean;
    pluralize?: boolean;
}): string;
export declare function getVarsFromFormatString(formatString: string): string[];
export declare function matchingParts(s: string, ref: string, options?: {
    caseInsensitive?: boolean;
}): {
    part: string;
    match: boolean;
}[];