Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect params for customGremlin in README #170

Closed
CodeWithOz opened this issue Aug 10, 2020 · 2 comments
Closed

Incorrect params for customGremlin in README #170

CodeWithOz opened this issue Aug 10, 2020 · 2 comments

Comments

@CodeWithOz
Copy link

The Basic Usage section of the README shows that the customGremlin function accepts 2 arguments, logger and randomizer, but in v2.2.0 the function receives only one argument which is an object that contains logger, randomizer, and window properties. Perhaps the Basic Usage code was meant to be this:

function customGremlin({logger, randomizer}) {
...
@HALLERPierre
Copy link
Contributor

Hi and thank you for your issue 😄 !

Yes you're absolutely right, the readme is wrong.
The correct way is:

function customGremlin({ logger, randomizer, window }) {
...

@HALLERPierre
Copy link
Contributor

I updated the Readme.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants