Clean up API (0.4.0 release)

[padolsey]

After a recent API addition (the element filter, see #11) I was considering a slight refactor of the way findAndReplaceDOMText is called. It's getting quite busy/lengthy at the moment and it may benefit from something like:

findAndReplaceDOMText(elementToSearch, {
  match: /foo/,
  replace: theReplacement,
  capture: optionalCaptureGroupNumber,
  filter: optionalElementFilterFunction
});

(i.e. an intuitive configuration object as the second arg)

Of course, the old way would still work but would be deprecated.

This would make it more readable and much easier to add new features without adding complexity to the already-long argument list.

I am planning this change for 0.4.0. Thoughts are welcome.

[padolsey]

I have made a provisional apiCleanup branch for people to play with. Let me know your thoughts. It'll most likely be completed and merged to master in the next few days.

Notable features are (see apiCleanup branch readme.md)

• Ability to replace plain text or wrap text with DOM nodes
• Cleaner API
• More meaningful portion/match objects passed to custom replace functions.
• Ability to choose between 'retain' and 'first' modes for portion-replacement-boundaries.
• More tests

[padolsey]

Another "feature" of the cleanup is that it retains support for the deprecated argument signature (findAndReplaceDOMText(regex, node, replace, ...)).

[padolsey]

0.4.0 is out.