Returns the raw string form of a template string.
Syntax
String.raw`templateStr`;
String.raw(obj, ...substitutions);
Parameters
templateStr
Required. The template string.
obj
Required. A well-formed object specified using object literal notation, such as { raw: 'value' }.
...substitutions
Optional. An array (a rest parameter) consisting of one or more substitution values.
Remarks
The String.raw function is intended for use with template strings. The raw string will include any escape characters and backslashes that are present in the string.
An error is thrown if obj is not a well-formed object.
Example
function log(arg) {
if(console && console.log) {
console.log(arg);
}
};
var name = "bob";
log(`hello \t${name}`);
log(String.raw`hello \t${name}`);
// The following usage for String.raw is supported but
// is not typical.
log(String.raw({ raw: 'fred'}, 'F', 'R', 'E'));
// Output:
// hello bob
// hello \tbob
// fFrReEd
Requirements
Supported in Microsoft Edge (Edge browser). Also supported in Store apps (Microsoft Edge on Windows 10). See Version Information.
Not supported in the following document modes: Quirks, Internet Explorer 6 standards, Internet Explorer 7 standards, Internet Explorer 8 standards, Internet Explorer 9 standards, Internet Explorer 10 standards, Internet Explorer 11 standards. Not supported in Windows 8.1.