async-str-replace

Note: This package has been deprecated and will no longer receive updates. However, it is still perfectly functional.

This package is a simple string replace function that can handle both synchronous and asynchronous replace operations. It accepts one or more replacement objects and replaces all occurrences of their search string with their replace string in the provided string.

Installation

This function can be used in both Node.js and browser environments. You can install it using npm or yarn:

npm install async-str-replace

# or

yarn add async-str-replace

Usage

const asyncStrReplace = require("async-str-replace");

const string = "Hello, world!";

const replacements = [
  {
    search: "world",
    replace: "there",
  },
  {
    search: /o/g,
    replace: async () => {
      // Some async operation...
      return "O";
    },
  },
];

async function main() {
  const result = await asyncStrReplace(string, replacements);
  console.log(result); // "HellO, there!"
}

main();

Deprecated

Please note that this package is now deprecated in favor of str-async-replace. Although async-str-replace is still fully functional, we recommend using str-async-replace for new projects, as it offers additional features and a more intuitive API.

str-async-replace can be installed via npm:

npm install str-async-replace

Please note that async-str-replace and str-async-replace do not function identically. For information on how to use str-async-replace, please consult its documentation: https://www.npmjs.com/package/str-async-replace

License

This package is licensed under the MIT License. See the LICENSE file for details.