Rename leadingCheck option to before (#17)

index.d.ts

@@ -17,11 +17,11 @@ declare namespace pWaitFor {
 		/**
 		Whether to run the check immediately rather than starting by waiting `interval` milliseconds.
 
-		Useful for when the check, if run immediately, would likely return `false`. In this scenario, set `leadingCheck` to `false`.
+		Useful for when the check, if run immediately, would likely return `false`. In this scenario, set `before` to `false`.
 
 		@default true
 		*/
-		readonly leadingCheck?: boolean;
+		readonly before?: boolean;
 	}
 }
 

index.js

@@ -5,7 +5,7 @@ const pWaitFor = async (condition, options) => {
 	options = {
 		interval: 20,
 		timeout: Infinity,
-		leadingCheck: true,
+		before: true,
 		...options
 	};
 
@@ -30,7 +30,7 @@ const pWaitFor = async (condition, options) => {
 			}
 		};
 
-		if (options.leadingCheck) {
+		if (options.before) {
 			check();
 		} else {
 			retryTimeout = setTimeout(check, options.interval);

index.test-d.ts

@@ -5,4 +5,4 @@ expectType<Promise<void>>(pWaitFor(() => false));
 expectType<Promise<void>>(pWaitFor(() => Promise.resolve(false)));
 expectType<Promise<void>>(pWaitFor(() => true, {interval: 1}));
 expectType<Promise<void>>(pWaitFor(() => true, {timeout: 1}));
-expectType<Promise<void>>(pWaitFor(() => true, {leadingCheck: false}));
+expectType<Promise<void>>(pWaitFor(() => true, {before: false}));

readme.md

@@ -52,14 +52,14 @@ Default: `Infinity`
 
 Number of milliseconds to wait before automatically rejecting.
 
-##### leadingCheck
+##### before
 
 Type: `boolean`\
 Default: `true`
 
 Whether to run the check immediately rather than starting by waiting `interval` milliseconds.
 
-Useful for when the check, if run immediately, would likely return `false`. In this scenario, set `leadingCheck` to `false`.
+Useful for when the check, if run immediately, would likely return `false`. In this scenario, set `before` to `false`.
 
 ## Related
 

test.js

@@ -65,7 +65,7 @@ test('does not perform a leading check', async t => {
 
 	await pWaitFor(async () => true, {
 		interval: ms,
-		leadingCheck: false
+		before: false
 	});
 
 	t.true(end() > (ms - 20));