A vesion of "string".replace() that knows how to wait
$ npm install string-replace-async
let replaceAsync = ;await;
Say you have a task of replacing color names with their respective hex codes.
let spec = "I want background to be #papayawhip and borders #rebeccapurple.";// make it "I want background to be #FFEFD5 (papayawhip) and borders #663399 (rebeccapurple).";
replace method built in, so you use it.
Time passes, a new requirement emerges: now you have to query a database for custom colors. This is an async operation, so naturally you convert
getColorByName into async function.
Turns out it has a cost: now all the code above should also be async. You try this:
Unfortunately, this code doesn't work as you expect. Built in menthod wasn't designed to work as async function.
This is where
string-replace-async comes in:
string-replace-async is nothing but direct
String.prototype.replace replacement that awaits your function and returns a Promise for results.
API is String.prototype.replace(), except the first argument is a string itself.
replaceAsync(string, searchValue, replace)
replace and waits for it to resolve before replacing
searchValue with results. If
searchValue is a global RegExp,
replace will be called concurrently for every match.
An input string.
An expression to match substrings to replace.
function that takes several arguments and returns a
promise. Resolved value will be used as replacement substring.
A Note on Concurrency
Previously this module had aditional menhod
seq() that ran
replace functions one by one instead of all at once. We decided to remove it to narrow our scope. Here's a snippet that achieves the same effect:
let sequence = Promise;let sequence = sequence;await;
MIT © Dmitrii Sobolev