/** * This file is part of the @egodigital/egoose distribution. * Copyright (c) e.GO Digital GmbH, Aachen, Germany (https://www.e-go-digital.com/) * * @egodigital/egoose is free software: you can redistribute it and/or modify * it under the terms of the GNU Lesser General Public License as * published by the Free Software Foundation, version 3. * * @egodigital/egoose is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this program. If not, see . */ import * as Enumerable from 'node-enumerable'; /** * A string format provider function. * * @param {any} val The input value. * @param {string} match The original match value. * * @return {any} The output value. */ export declare type StringFormatProvider = (val: any, match: string) => any; /** * A list of string format providers. */ export declare type StringFormatProviderList = { [name: string]: StringFormatProvider; }; /** * Formats a string. * * @param {any} formatStr The value that represents the format string. * @param {any[]} [args] The arguments for 'formatStr'. * * @return {string} The formated string. */ export declare function format(formatStr: any, ...args: any[]): string; /** * Formats a string. * * @param {any} formatStr The value that represents the format string. * @param {Enumerable.Sequence} [args] The arguments for 'formatStr'. * * @return {string} The formated string. */ export declare function formatArray(formatStr: any, args: Enumerable.Sequence): string; /** * Returns a (new) list of default string format providers, grouped by name. * * @return {StringFormatProviderList} The new list. */ export declare function getDefaultStringFormatProviders(): StringFormatProviderList; /** * Registers a new list of global string format providers. * * @param {StringFormatProviderList} [providers] The new list. * @param {boolean} [withDefaults] Also register default providers first. Default: (true) */ export declare function registerStringFormatProviders(providers?: StringFormatProviderList, withDefaults?: boolean): void;