RegExp.prototype.multiline

{{JSRef}} 

The multiline accessor property of {{jsxref("RegExp")}}  instances returns whether or not the m flag is used with this regular expression.

{{InteractiveExample("JavaScript Demo: RegExp.prototype.multiline", "taller")}} 

const regex1 = new RegExp("^football");
const regex2 = new RegExp("^football", "m");

console.log(regex1.multiline);
// Expected output: false

console.log(regex2.multiline);
// Expected output: true

console.log(regex1.test("rugby\nfootball"));
// Expected output: false

console.log(regex2.test("rugby\nfootball"));
// Expected output: true

Description

RegExp.prototype.multiline has the value true if the m flag was used; otherwise, false. The m flag indicates that a multiline input string should be treated as multiple lines. For example, if m is used, ^ and $ change from matching at only the start or end of the entire string to the start or end of any line within the string.

The set accessor of multiline is undefined. You cannot change this property directly.

Examples

Using multiline

const regex = /foo/m;

console.log(regex.multiline); // true

Specifications

{{Specifications}} 

Browser compatibility

{{Compat}} 

See also

• {{jsxref("RegExp.prototype.lastIndex")}} 
• {{jsxref("RegExp.prototype.dotAll")}} 
• {{jsxref("RegExp.prototype.global")}} 
• {{jsxref("RegExp.prototype.hasIndices")}} 
• {{jsxref("RegExp.prototype.ignoreCase")}} 
• {{jsxref("RegExp.prototype.source")}} 
• {{jsxref("RegExp.prototype.sticky")}} 
• {{jsxref("RegExp.prototype.unicode")}}