String.prototype.link()

Deprecated: This feature is no longer recommended. Though some browsers might still support it, it may have already been removed from the relevant web standards, may be in the process of being dropped, or may only be kept for compatibility purposes. Avoid using it, and update existing code if possible; see the compatibility table at the bottom of this page to guide your decision. Be aware that this feature may cease to work at any time.

The link() method creates a string that embeds a string in an <a> element (<a href="...">str</a>), to be used as a hypertext link to another URL.

Note: All HTML wrapper methods are deprecated and only standardized for compatibility purposes. Use DOM APIs such as document.createElement() instead.

Syntax

link(url)

Parameters

url

Any string that specifies the href attribute of the <a> element; it should be a valid URL (relative or absolute), with any & characters escaped as &amp;.

Return value

A string beginning with an <a href="url"> start tag (double quotes in url are replaced with &quot;), then the text str, and then an </a> end tag.

Examples

The following example displays the word "MDN" as a hypertext link that returns the user to the Mozilla Developer Network.

const hotText = "MDN";
const url = "https://developer.mozilla.org/";

console.log(`Click to return to ${hotText.link(url)}`);
// Click to return to <a href="https://developer.mozilla.org/">MDN</a>

Specifications

Specification
ECMAScript Language Specification
# sec-string.prototype.link

Browser compatibility

BCD tables only load in the browser

See also