search

andywer / leakage

🐛 Memory leak testing for node.
1.58k stars 52 forks source link

Updated README.md and added mocha to run the existing test. #1

Closed tydira closed 7 years ago

tydira commented 7 years ago

When I imported 'iterate' from the package, the value was undefined. I realized that the README.md was misleading, so this PR adjusts it to reflect what the package exports ('iteration').

I'm having another issue with the library, which might end up in another PR, so I wanted to run the test suite to see what happens and realized that it didn't come with mocha and needed an improved test command (both using mocha and not relying on any local PATH modifications).

andywer commented 7 years ago

Ahhh, I'm sorry for the misleading docs, guys! Thanks for fixing, @kroogs!

andywer commented 7 years ago

@btmills @kroogs Do you prefer iterate or iteration?

btmills commented 7 years ago

iterate feels more natural to me. And if you want to avoid a breaking change, you can rename it and change the docs, then do module.exports = { iterate, iteration: iterate };, while officially deprecating iteration.

andywer commented 7 years ago

@btmills Yeah, feeling the same. I will just edit the PR.

andywer commented 7 years ago

Or maybe not... Guess it's easier to start a new one, since editing so much isn't easy using the GitHub web UI.

andywer commented 7 years ago

Opened a new PR. Still thankful that you opened this one, @kroogs :)