Skip to main content

String and RegExp

About 4 minfeaturees-standard

String and RegExp

Modules

The main part of String features:

Adding support of well-known symbols @@match, @@replace, @@search and @@split and direct .exec calls to related String methods:

Annex B methods:

RegExp features:

Types

interface String {
  at(index: number): string;
  includes(searchString: string, position?: number): boolean;
  startsWith(searchString: string, position?: number): boolean;
  endsWith(searchString: string, position?: number): boolean;
  repeat(count: number): string;
  /**@param fillStr @default ' '' */
  padStart(length: number, fillStr?: string): string;
  /**@param fillStr @default ' '' */
  padEnd(length: number, fillStr?: string): string;
  codePointAt(pos: number): number | void;
  match(template: any): RegExpMatchArray | null; // ES2015+ fix for support @@match
  matchAll(regexp: RegExp): Iterator<RegExpMatchArray>;
  replace(template: any, replacer: any): any; // ES2015+ fix for support @@replace
  replaceAll(
    searchValue: string | RegExp,
    replacer: string | ((searchValue: string, ...args: any[]) => string)
  ): string;
  search(template: any): any; // ES2015+ fix for support @@search
  split(template: any, limit?: number): Array<string>; // ES2015+ fix for support @@split, some fixes for old engines
  trim(): string;
  trimLeft(): string;
  trimRight(): string;
  trimStart(): string;
  trimEnd(): string;
  isWellFormed(): boolean;
  toWellFormed(): string;
  anchor(name: string): string;
  big(): string;
  blink(): string;
  bold(): string;
  fixed(): string;
  fontcolor(color: string): string;
  fontsize(size: any): string;
  italics(): string;
  link(url: string): string;
  small(): string;
  strike(): string;
  sub(): string;
  substr(start: number, length?: number): string;
  sup(): string;
  [Symbol.iterator]: Iterator<String>;
}

interface StringConstructor {
  fromCodePoint(...codePoints: Array<number>): string;
  raw({ ["raw"]: Array }, ...substitutions: Array<string>): string;
}

class RegExp {
  // support of sticky (`y`) flag, dotAll (`s`) flag, named capture groups, can alter flags
  constructor(pattern: RegExp | string, flags?: string);
  exec(): Array<string | undefined> | null; // IE8 fixes
  test(string: string): boolean; // delegation to `.exec`
  toString(): string; // ES2015+ fix - generic
  [Symbol.match](string: string): RegExpMatchArray | null;
  [Symbol.matchAll](string: string): Iterator<RegExpMatchArray>;
  [Symbol.replace](string: string, replaceValue: Function | string): string;
  [Symbol.search](string: string): number;
  [Symbol.split](string: string, limit: number): Array<string>;
  readonly dotAll: boolean; // IE9+
  readonly flags: string; // IE9+
  readonly sticky: boolean; // IE9+
}

function escape(string: string): string;
function unescape(string: string): string;

Entry points

core-js(-pure)/es|stable|actual|full/string
core-js(-pure)/es|stable|actual|full/string/from-code-point
core-js(-pure)/es|stable|actual|full/string/raw
core-js/es|stable|actual|full/string/match
core-js/es|stable|actual|full/string/replace
core-js/es|stable|actual|full/string/search
core-js/es|stable|actual|full/string/split
core-js(-pure)/es|stable|actual/string(/virtual)/at
core-js(-pure)/es|stable|actual|full/string(/virtual)/code-point-at
core-js(-pure)/es|stable|actual|full/string(/virtual)/ends-with
core-js(-pure)/es|stable|actual|full/string(/virtual)/includes
core-js(-pure)/es|stable|actual|full/string(/virtual)/starts-with
core-js(-pure)/es|stable|actual|full/string(/virtual)/match-all
core-js(-pure)/es|stable|actual|full/string(/virtual)/pad-start
core-js(-pure)/es|stable|actual|full/string(/virtual)/pad-end
core-js(-pure)/es|stable|actual|full/string(/virtual)/repeat
core-js(-pure)/es|stable|actual|full/string(/virtual)/replace-all
core-js(-pure)/es|stable|actual|full/string(/virtual)/trim
core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-start
core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-end
core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-left
core-js(-pure)/es|stable|actual|full/string(/virtual)/trim-right
core-js(-pure)/es|stable|actual|full/string(/virtual)/is-well-formed
core-js(-pure)/es|stable|actual|full/string(/virtual)/to-well-formed
core-js(-pure)/es|stable|actual|full/string(/virtual)/anchor
core-js(-pure)/es|stable|actual|full/string(/virtual)/big
core-js(-pure)/es|stable|actual|full/string(/virtual)/blink
core-js(-pure)/es|stable|actual|full/string(/virtual)/bold
core-js(-pure)/es|stable|actual|full/string(/virtual)/fixed
core-js(-pure)/es|stable|actual|full/string(/virtual)/fontcolor
core-js(-pure)/es|stable|actual|full/string(/virtual)/fontsize
core-js(-pure)/es|stable|actual|full/string(/virtual)/italics
core-js(-pure)/es|stable|actual|full/string(/virtual)/link
core-js(-pure)/es|stable|actual|full/string(/virtual)/small
core-js(-pure)/es|stable|actual|full/string(/virtual)/strike
core-js(-pure)/es|stable|actual|full/string(/virtual)/sub
core-js(-pure)/es|stable|actual|full/string(/virtual)/substr
core-js(-pure)/es|stable|actual|full/string(/virtual)/sup
core-js(-pure)/es|stable|actual|full/string(/virtual)/iterator
core-js/es|stable|actual|full/regexp
core-js/es|stable|actual|full/regexp/constructor
core-js/es|stable|actual|full/regexp/dot-all
core-js(-pure)/es|stable|actual|full/regexp/flags
core-js/es|stable|actual|full/regexp/sticky
core-js/es|stable|actual|full/regexp/test
core-js/es|stable|actual|full/regexp/to-string
core-js/es|stable|actual|full/escape
core-js/es|stable|actual|full/unescape

Example

Exampleopen in new window:

for (let value of "a𠮷b") {
  console.log(value); // => 'a', '𠮷', 'b'
}

"foobarbaz".includes("bar"); // => true
"foobarbaz".includes("bar", 4); // => false
"foobarbaz".startsWith("foo"); // => true
"foobarbaz".startsWith("bar", 3); // => true
"foobarbaz".endsWith("baz"); // => true
"foobarbaz".endsWith("bar", 6); // => true

"string".repeat(3); // => 'stringstringstring'

"hello".padStart(10); // => '     hello'
"hello".padStart(10, "1234"); // => '12341hello'
"hello".padEnd(10); // => 'hello     '
"hello".padEnd(10, "1234"); // => 'hello12341'

"𠮷".codePointAt(0); // => 134071
String.fromCodePoint(97, 134071, 98); // => 'a𠮷b'

let name = "Bob";
String.raw`Hi\n${name}!`; // => 'Hi\\nBob!' (ES2015 template string syntax)
String.raw({ raw: "test" }, 0, 1, 2); // => 't0e1s2t'

"foo".bold(); // => '<b>foo</b>'
"bar".anchor('a"b'); // => '<a name="a&quot;b">bar</a>'
"baz".link("https://example.com"); // => '<a href="https://example.com">baz</a>'

RegExp(".", "s").test("\n"); // => true
RegExp(".", "s").dotAll; // => true

RegExp("foo:(?<foo>\\w+),bar:(?<bar>\\w+)").exec("foo:abc,bar:def").groups.bar; // => 'def'

"foo:abc,bar:def".replace(
  RegExp("foo:(?<foo>\\w+),bar:(?<bar>\\w+)"),
  "$<bar>,$<foo>"
); // => 'def,abc'

RegExp(/./g, "m"); // => /./m

/foo/.flags; // => ''
/foo/gim.flags; // => 'gim'

RegExp("foo", "y").sticky; // => true

const text = "First line\nSecond line";
const regex = RegExp("(\\S+) line\\n?", "y");

regex.exec(text)[1]; // => 'First'
regex.exec(text)[1]; // => 'Second'
regex.exec(text); // => null

"foo".match({ [Symbol.match]: () => 1 }); // => 1
"foo".replace({ [Symbol.replace]: () => 2 }); // => 2
"foo".search({ [Symbol.search]: () => 3 }); // => 3
"foo".split({ [Symbol.split]: () => 4 }); // => 4

RegExp.prototype.toString.call({ source: "foo", flags: "bar" }); // => '/foo/bar'

"   hello   ".trimLeft(); // => 'hello   '
"   hello   ".trimRight(); // => '   hello'
"   hello   ".trimStart(); // => 'hello   '
"   hello   ".trimEnd(); // => '   hello'

for (let [_, d, D] of "1111a2b3cccc".matchAll(/(\d)(\D)/g)) {
  console.log(d, D); // => 1 a, 2 b, 3 c
}

"Test abc test test abc test.".replaceAll("abc", "foo"); // -> 'Test foo test test foo test.'

"abc".at(1); // => 'b'
"abc".at(-1); // => 'c'

"a💩b".isWellFormed(); // => true
"a\uD83Db".isWellFormed(); // => false
"a💩b".toWellFormed(); // => 'a💩b'
"a\uD83Db".toWellFormed(); // => 'a�b'
© 2014-2023 Core-JS contributors