String.raw()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2015.

Die statische Methode String.raw() ist eine Tag-Funktion von Template Literals. Dies ist ähnlich wie das r-Präfix in Python oder das @-Präfix in C# für String-Literale. Sie wird verwendet, um die rohe Stringform von Template-Literalen zu erhalten – das heißt, Substitutionen (z.B. ${foo}) werden verarbeitet, aber Escape-Sequenzen (z.B. \n) werden nicht verarbeitet.

Probieren Sie es aus

Syntax

js
String.raw(strings)
String.raw(strings, sub1)
String.raw(strings, sub1, sub2)
String.raw(strings, sub1, sub2, /* …, */ subN)

String.raw`templateString`

Parameter

strings

Ein wohlgeformtes Template-Literal-Array-Objekt, wie { raw: ['foo', 'bar', 'baz'] }. Sollte ein Objekt mit einer raw Eigenschaft sein, dessen Wert ein array-ähnliches Objekt von Strings ist.

sub1, …, subN

Beinhaltet Substitutionswerte.

templateString

Ein Template Literal, optional mit Substitutionen (${...}).

Rückgabewert

Die rohe Stringform eines gegebenen Template-Literals.

Ausnahmen

TypeError

Wird ausgelöst, wenn das erste Argument keine raw Eigenschaft hat oder die raw Eigenschaft undefined oder null ist.

Beschreibung

In den meisten Fällen wird String.raw() mit Template-Literals verwendet. Die oben erwähnte erste Syntax wird nur selten genutzt, weil die JavaScript-Engine dies mit den richtigen Argumenten für Sie aufruft (genauso wie bei anderen Tag-Funktionen).

String.raw() ist das einzige eingebaute Tag für Template-Literale. Es hat ähnliche Semantik wie ein ungetaggtes Literal, da es alle Argumente zusammenfügt und einen String zurückgibt. Sie können es sogar mit normalem JavaScript-Code neu implementieren.

Warnung: Sie sollten String.raw nicht direkt als "Identitäts"-Tag verwenden. Siehe Erstellen eines Identitätstags, um zu erfahren, wie Sie dies implementieren können.

Wenn String.raw() mit einem Objekt aufgerufen wird, dessen raw Eigenschaft keine length Eigenschaft oder eine nicht positive length hat, wird ein leerer String "" zurückgegeben. Wenn substitutions.length < strings.raw.length - 1 (d.h. es gibt nicht genug Substitutionen, um die Platzhalter zu füllen – was in einem wohlgeformten getaggten Template-Literal nicht passieren kann), werden die restlichen Platzhalter mit leeren Strings gefüllt.

Beispiele

Verwendung von String.raw()

js
String.raw`Hi\n${2 + 3}!`;
// 'Hi\\n5!', the character after 'Hi'
// is not a newline character,
// '\' and 'n' are two characters.

String.raw`Hi\u000A!`;
// 'Hi\\u000A!', same here, this time we will get the
// \, u, 0, 0, 0, A, 6 characters.
// All kinds of escape characters will be ineffective
// and backslashes will be present in the output string.
// You can confirm this by checking the .length property
// of the string.

const name = "Bob";
String.raw`Hi\n${name}!`;
// 'Hi\\nBob!', substitutions are processed.

String.raw`Hi \${name}!`;
// 'Hi \\${name}!', the dollar sign is escaped; there's no interpolation.

Verwendung von String.raw mit RegExp

Die Kombination eines String.raw Template-Literals mit dem RegExp() Konstruktor ermöglicht es Ihnen, reguläre Ausdrücke mit dynamischen Teilen zu erstellen (was mit Regex-Literalen nicht möglich ist) ohne das doppelte Escaping (\\) von regulären Ausdruck-Escape-Sequenzen (was mit normalen String-Literalen nicht möglich ist). Dies ist auch in Strings, die viele Schrägstriche enthalten, wie Dateipfade oder URLs, wertvoll.

js
// A String.raw template allows a fairly readable regular expression matching a URL:
const reRawTemplate = new RegExp(
  String.raw`https://developer\.mozilla\.org/en-US/docs/Web/JavaScript/Reference/`,
);

// The same thing with a regexp literal looks like this, with \/ for
// each forward slash:
const reRegexpLiteral =
  /https:\/\/developer\.mozilla\.org\/en-US\/docs\/Web\/JavaScript\/Reference\//;

// And the same thing written with the RegExp constructor and a
// traditional string literal, with \\. for each period:
const reStringLiteral = new RegExp(
  "https://developer\\.mozilla\\.org/en-US/docs/Web/JavaScript/Reference/",
);

// String.raw also allows dynamic parts to be included
function makeURLRegExp(path) {
  return new RegExp(String.raw`https://developer\.mozilla\.org/${path}`);
}

const reDynamic = makeURLRegExp("en-US/docs/Web/JavaScript/Reference/");
const reWildcard = makeURLRegExp(".*");

Erstellen eines Identitätstags

Viele Tools bevorzugen spezielle Behandlung von Literalen, die mit einem bestimmten Namen getaggt sind.

js
// Some formatters will format this literal's content as HTML
const doc = html`<!doctype html>
  <html lang="en-US">
    <head>
      <title>Hello</title>
    </head>
    <body>
      <h1>Hello world!</h1>
    </body>
  </html>`;

Man könnte das html Tag naiv wie folgt implementieren:

js
const html = String.raw;

Dies funktioniert tatsächlich für den obigen Fall. Allerdings würde String.raw die rohen String-Literale statt der "gekochten" zusammenfügen, sodass Escape-Sequenzen nicht verarbeitet würden.

js
const doc = html`<canvas>\n</canvas>`;
// "<canvas>\\n</canvas>"

Dies mag nicht das sein, was Sie für ein "echtes Identitätstag" wollen, bei dem das Tag nur für die Markierung dient und den Wert des Literals nicht ändert. In diesem Fall können Sie ein benutzerdefiniertes Tag erstellen und das "gekochte" (d.h. Escape-Sequenzen sind verarbeitet) Literal-Array an String.raw übergeben und vortäuschen, dass es rohe Strings sind.

js
const html = (strings, ...values) => String.raw({ raw: strings }, ...values);
// Some formatters will format this literal's content as HTML
const doc = html`<canvas>\n</canvas>`;
// "<canvas>\n</canvas>"; the "\n" becomes a line break

Beachten Sie, dass das erste Argument ein Objekt mit einer raw Eigenschaft ist, dessen Wert ein array-ähnliches Objekt (mit einer length Eigenschaft und ganzzahligen Indizes) darstellt, das die getrennten Strings im Template-Literal repräsentiert. Der Rest der Argumente sind die Substitutionen. Da der raw Wert jedes array-ähnliche Objekt sein kann, kann es sogar ein String sein! Zum Beispiel, 'test' wird behandelt wie ['t', 'e', 's', 't']. Das Folgende ist gleichwertig zu `t${0}e${1}s${2}t`:

js
String.raw({ raw: "test" }, 0, 1, 2); // 't0e1s2t'

Spezifikationen

Specification
ECMAScript® 2025 Language Specification
# sec-string.raw

Browser-Kompatibilität

BCD tables only load in the browser

Siehe auch