From 2759c5c70cd947716bc1a1e58a9e6fa84e7a1943 Mon Sep 17 00:00:00 2001 From: Jae Page Date: Wed, 18 Jan 2017 15:51:29 -0800 Subject: [PATCH] Document return value of `check` method. --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 526c68b..e4598de 100644 --- a/README.md +++ b/README.md @@ -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