Function templateFormatString

src/lib/index.js:1133–1224

* Substitute values from an object into a string and optionally formats them using d3-format, * or fallback to associated labels. * * Examples: * Lib.templateFormatString({ template 'name: %{trace}', labels: {trace: 'asdf'} }) --> 'name: asdf' * Lib.templateFormatString({ template: 'name: %{t

({ data = [], locale, fallback, labels = {}, opts, template })

 * @return {string} templated string
 */
function templateFormatString({ data = [], locale, fallback, labels = {}, opts, template }) {
    return template.replace(lib.TEMPLATE_STRING_REGEX, (match, key, format) => {
        const isOther = ['xother', 'yother'].includes(key);
        const isSpaceOther = ['_xother', '_yother'].includes(key);
        const isSpaceOtherSpace = ['_xother_', '_yother_'].includes(key);
        const isOtherSpace = ['xother_', 'yother_'].includes(key);
        const hasOther = isOther || isSpaceOther || isOtherSpace || isSpaceOtherSpace;

        // Remove underscores from key
        if (isSpaceOther || isSpaceOtherSpace) key = key.substring(1);
        if (isOtherSpace || isSpaceOtherSpace) key = key.substring(0, key.length - 1);

        let parsedOp = null;
        let parsedNumber = null;
        if (opts.parseMultDiv) {
            var _match = multDivParser(key);
            key = _match.key;
            parsedOp = _match.op;
            parsedNumber = _match.number;
        }

        let value = undefined;
        if (hasOther) {
            // 'other' specifiers that are undefined return an empty string by design
            if (labels[key] === undefined) return '';
            value = labels[key];
        } else {
            for (const obj of data) {
                if (!obj) continue;
                if (obj.hasOwnProperty(key)) {
                    value = obj[key];
                    break;
                }

                if (!SIMPLE_PROPERTY_REGEX.test(key)) {
                    // true here means don't convert null to undefined
                    value = lib.nestedProperty(obj, key).get(true);
                }
                if (value !== undefined) break;
            }
        }

        if (value === undefined) {
            const { count, max, name } = opts;
            const fallbackValue = fallback === false ? match : fallback;
            if (count < max) {
                lib.warn(
                    [
                        `Variable '${key}' in ${name} could not be found!`,
                        'Please verify that the template is correct.',
                        `Using value: '${fallbackValue}'.`
                    ].join(' ')
                );
            }
            if (count === max) lib.warn(`Too many '${name}' warnings - additional warnings will be suppressed.`);
            opts.count++;

            return fallbackValue;