Rename leading to before (#23)

Co-authored-by: Sindre Sorhus <sindresorhus@gmail.com>

index.d.ts

@@ -5,7 +5,7 @@ declare namespace pDebounce {
 
 		@default false
 		*/
-		readonly leading?: boolean;
+		readonly before?: boolean;
 	}
 }
 

index.js

@@ -4,19 +4,19 @@ const pDebounce = (fn, wait, options = {}) => {
 	}
 
 	let leadingValue;
-	let timer;
+	let timeout;
 	let resolveList = [];
 
 	return function (...arguments_) {
 		return new Promise(resolve => {
-			const runImmediately = options.leading && !timer;
+			const shouldCallNow = options.before && !timeout;
 
-			clearTimeout(timer);
+			clearTimeout(timeout);
 
-			timer = setTimeout(() => {
-				timer = null;
+			timeout = setTimeout(() => {
+				timeout = null;
 
-				const result = options.leading ? leadingValue : fn.apply(this, arguments_);
+				const result = options.before ? leadingValue : fn.apply(this, arguments_);
 
 				for (resolve of resolveList) {
 					resolve(result);
@@ -25,7 +25,7 @@ const pDebounce = (fn, wait, options = {}) => {
 				resolveList = [];
 			}, wait);
 
-			if (runImmediately) {
+			if (shouldCallNow) {
 				leadingValue = fn.apply(this, arguments_);
 				resolve(leadingValue);
 			} else {

index.test-d.ts

@@ -5,7 +5,7 @@ const expensiveCall = async (input: number) => input;
 
 expectType<(input: number) => Promise<number>>(pDebounce(expensiveCall, 200));
 expectType<(input: number) => Promise<number>>(
-	pDebounce(expensiveCall, 200, {leading: true})
+	pDebounce(expensiveCall, 200, {before: true})
 );
 expectType<(input: number) => Promise<number>>(
 	pDebounce.promise(expensiveCall)

readme.md

@@ -47,7 +47,7 @@ Milliseconds to wait before calling `fn`.
 
 Type: `object`
 
-##### leading
+##### before
 
 Type: `boolean`\
 Default: `false`

test.js

@@ -48,14 +48,14 @@ test('.promise()', async t => {
 	t.is(await debounced(), 2);
 });
 
-test('leading option', async t => {
+test('before option', async t => {
 	let count = 0;
 
 	const debounced = pDebounce(async value => {
 		count++;
 		await delay(50);
 		return value;
-	}, 100, {leading: true});
+	}, 100, {before: true});
 
 	const results = await Promise.all([1, 2, 3, 4].map(value => debounced(value)));
 
@@ -67,12 +67,12 @@ test('leading option', async t => {
 	t.is(await debounced(6), 5);
 });
 
-test('leading option - does not call input function after timeout', async t => {
+test('before option - does not call input function after timeout', async t => {
 	let count = 0;
 
 	const debounced = pDebounce(async () => {
 		count++;
-	}, 100, {leading: true});
+	}, 100, {before: true});
 
 	await delay(300);
 	await debounced();