Ruby's String.gsub in TypeScript

How to use

Install via yarn add locutus and import: import { gsub } from 'locutus/ruby/String/gsub'.

Or with CommonJS: const { gsub } = require('locutus/ruby/String/gsub')

Use a bundler that supports tree-shaking so you only ship the functions you actually use. Vite, webpack, Rollup, and Parcel all handle this. For server-side use this is less of a concern.

Examples

These examples are extracted from test cases that automatically verify our functions against their native counterparts.

#	code	expected result
1	gsub('hello world', 'l', 'L')	'heLLo worLd'
2	gsub('abcabc', 'ab', '#')	'#c#c'
3	gsub('foo', 'x', 'y')	'foo'

Ruby nil and TypeScript/JavaScript undefined

Ruby's nil and TypeScript/JavaScript undefined are semantically equivalent—both represent "no value" or "nothing here". However, they serialize differently: nil becomes null in JSON, while undefined is typically omitted or becomes undefined.

Locutus Ruby functions return undefined (idiomatic TypeScript/JavaScript) where Ruby would return nil. Our parity tests treat these as equivalent when verifying against native Ruby.

Notes

• Global substitution across the entire string.

Here's what our current TypeScript equivalent to Ruby's String.gsub looks like.

TSTypeScript JSJavaScript TSStandalone TS JSStandalone JS

Copy code

export function gsub(str: string, pattern: string | RegExp, replacement: string): string {
  // parity verified: Ruby 3.3
  //      discuss at: https://locutus.io/ruby/String/gsub/
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //          note 1: Global substitution across the entire string.
  //       example 1: gsub('hello world', 'l', 'L')
  //       returns 1: 'heLLo worLd'
  //       example 2: gsub('abcabc', 'ab', '#')
  //       returns 2: '#c#c'
  //       example 3: gsub('foo', 'x', 'y')
  //       returns 3: 'foo'

  const source = String(str)
  const replacementText = String(replacement)

  if (pattern instanceof RegExp) {
    const flags = pattern.flags.includes('g') ? pattern.flags : `${pattern.flags}g`
    return source.replace(new RegExp(pattern.source, flags), replacementText)
  }

  const needle = String(pattern)
  if (needle === '') {
    return source
  }

  return source.replaceAll(needle, replacementText)
}

export function gsub(str, pattern, replacement) {
  // parity verified: Ruby 3.3
  //      discuss at: https://locutus.io/ruby/String/gsub/
  //     original by: Kevin van Zonneveld (https://kvz.io)
  //          note 1: Global substitution across the entire string.
  //       example 1: gsub('hello world', 'l', 'L')
  //       returns 1: 'heLLo worLd'
  //       example 2: gsub('abcabc', 'ab', '#')
  //       returns 2: '#c#c'
  //       example 3: gsub('foo', 'x', 'y')
  //       returns 3: 'foo'

  const source = String(str)
  const replacementText = String(replacement)

  if (pattern instanceof RegExp) {
    const flags = pattern.flags.includes('g') ? pattern.flags : `${pattern.flags}g`
    return source.replace(new RegExp(pattern.source, flags), replacementText)
  }

  const needle = String(pattern)
  if (needle === '') {
    return source
  }

  return source.replaceAll(needle, replacementText)
}

Improve this function

Locutus is a community effort following The McDonald's Theory: we ship first iterations, hoping others will improve them. If you see something that could be better, we'd love your contribution.

View on GitHub · Edit on GitHub · View Raw

---

We have 39 Ruby functions so far - help us add more

Got a rainy Sunday afternoon and a taste for a porting puzzle?

• Get inspiration from the Ruby core documentation.
• Click "New file" in the appropriate folder on GitHub. This will fork the project to your account, directly add the file to it, and send a Pull Request to us.

We will then review it. If it's useful to the project and in line with our contributing guidelines your work will become part of Locutus and you'll be automatically credited in the authors section accordingly.

---

« More Ruby String functions

Star