Getting Started

A quick start guide.

Installation

Shell

tns plugin add nativescript-enumerable

Import

JavaScript

import StringFormat = require("nativescript-stringformat");

Examples

Simple example

JavaScript

// "TM + MK"
StringFormat.format("{0} + {1}",
                    "TM",  // {0}
                    "MK");  // {1}

// the alternative:
StringFormat.formatArray("{0} + {1}",
                         ["TM", "MK"]);

Custom order of arguments

JavaScript

// "Marcel Kloubert"
StringFormat.format("{1} {0}",
                    "Kloubert",   // {0}
                    "Marcel");  // {1}

Functions as arguments

JavaScript

// "23091979 + 5091979 = 28183958"
StringFormat.format("{0} + {1} = {2}",
                    23091979,  // {0}
                    5091979,  // {1}
                    function (index, args) {  // {2}
                        return args[0] + args[1];  // 28183958
                    });

The full signature of a function:

JavaScript

function (index, args, match, formatExpr, funcDepth) {
    return <THE-VALUE-TO-USE>;
}

Name	Description
index	The index value of the argument. For {7} this will be 7.
args	The values that were passed to the underlying format() or formatArray() function.
match	The complete (unhandled) expression of the argument.
formatExpr	The optional format expression of the argument. For {0:lower} this will be lower.
funcDepth	This value is 0 at the beginning. If you return a function in that function again, this will increase until you stop to return a function.