Skip to content

Commit

Permalink
Merge pull request #17 from jaepage/patch-1
Browse files Browse the repository at this point in the history
Document return value of `check` method.
  • Loading branch information
sitexw authored Jan 18, 2017
2 parents b2f6c38 + 2759c5c commit bf4c340
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,9 @@ Method available
// #value: string
blockAdBlock.setOption(options, value);

// Allows to check if AdBlock is enabled
// Manually check if AdBlock is enabled.
// Returns `true` upon completion of check.
// Returns `false` if check cannot be performed (eg due to another check in progress).
// The parameter 'loop' allows checking without loop several times according to the value of 'loopMaxNumber'
// Example: loop=true => time~=200ms (time varies depending on the configuration)
// loop=false => time~=1ms
Expand Down

0 comments on commit bf4c340

Please sign in to comment.