Skip to content

Commit bf4c340

Browse files
authored
Merge pull request #17 from jaepage/patch-1
Document return value of `check` method.
2 parents b2f6c38 + 2759c5c commit bf4c340

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,9 @@ Method available
103103
// #value: string
104104
blockAdBlock.setOption(options, value);
105105

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

0 commit comments

Comments
 (0)