feat: 修改参数名

Author: cssmagic

src/retry.js

@@ -7,42 +7,42 @@ function _sleep(time) {
 
 const MSG = {
 	ARG_VALIDATOR__FN: '[Retry] argument `validator` is not a function',
-	ARG_RETRIES__INT: '[Retry] argument `retries` must be an integer',
-	ARG_RETRIES__POS: '[Retry] argument `retries` must be greater than 0',
-	ARG_TIMEOUT__NUM: '[Retry] argument `timeout` must be a number',
-	ARG_TIMEOUT__POS: '[Retry] argument `timeout` must be greater than 0',
+	ARG_ATTEMPTS__INT: '[Retry] argument `attempts` must be an integer',
+	ARG_ATTEMPTS__POS: '[Retry] argument `attempts` must be greater than 0',
+	ARG_INTERVAL__NUM: '[Retry] argument `interval` must be a number',
+	ARG_INTERVAL__POS: '[Retry] argument `interval` must be greater than 0',
 }
 
 /**
  * 一个简单的重试方法
  * @param {function} validator 函数或异步函数，检查器，判断是否满足检查条件
  * @param {Object} options 重试参数
- * - options.retries {number} 最大重试次数，默认5次
- * - options.timeout {number} 重试间隔(毫秒)，默认10秒
+ * - options.attempts {number} 最大重试次数，默认5次
+ * - options.interval {number} 重试间隔(毫秒)，默认10秒
  * - options.name {string} 为当前重试任务起个名字；如未提供，则会自动生成一个唯一 ID
  * - options.debug {boolean} 是否调试模式。调试模式会输出更多日志
  */
 async function retry(validator, {
-	retries = 5,
-	timeout = 10000,
+	attempts = 5,
+	interval = 10000,
 	name = '',
 	debug = false,
 } = {}) {
 
 	if (typeof validator !== 'function') {
 		throw Error(MSG.ARG_VALIDATOR__FN)
 	}
-	if (!Number.isInteger(retries)) {
-		throw Error(MSG.ARG_RETRIES__INT)
+	if (!Number.isInteger(attempts)) {
+		throw Error(MSG.ARG_ATTEMPTS__INT)
 	}
-	if (retries < 0) {
-		throw Error(MSG.ARG_RETRIES__POS)
+	if (attempts < 0) {
+		throw Error(MSG.ARG_ATTEMPTS__POS)
 	}
-	if (typeof timeout !== 'number') {
-		throw Error(MSG.ARG_TIMEOUT__NUM)
+	if (typeof interval !== 'number') {
+		throw Error(MSG.ARG_INTERVAL__NUM)
 	}
-	if (timeout < 0) {
-		throw Error(MSG.ARG_TIMEOUT__POS)
+	if (interval < 0) {
+		throw Error(MSG.ARG_INTERVAL__POS)
 	}
 
 	// debug
@@ -54,12 +54,12 @@ async function retry(validator, {
 	do {
 		result = await validator()
 		times++
-		await _sleep(timeout)
+		await _sleep(interval)
 
 		// debug
 		if (debug) console.log(`[Retry] trying "${name}" #${times} and get result:`, result)
 
-	} while (times <= retries && !result)
+	} while (times <= attempts && !result)
 
 	if (result) {
 		// debug

test/retry.test.js

@@ -8,33 +8,33 @@ describe('retry()', () => {
 			expect.assertions(1)
 			await expect(retry()).rejects.toThrow(MSG.ARG_VALIDATOR__FN)
 		})
-		test('quit if `retries` is not an integer', async () => {
+		test('quit if `attempts` is not an integer', async () => {
 			expect.assertions(1)
 			await expect(retry(function () {}, {
-				retries: 1.1,
-				timeout: 0,
-			})).rejects.toThrow(MSG.ARG_RETRIES__INT)
+				attempts: 1.1,
+				interval: 0,
+			})).rejects.toThrow(MSG.ARG_ATTEMPTS__INT)
 		})
-		test('quit if `retries` < 0', async () => {
+		test('quit if `attempts` < 0', async () => {
 			expect.assertions(1)
 			await expect(retry(function () {}, {
-				retries: -1,
-				timeout: 0,
-			})).rejects.toThrow(MSG.ARG_RETRIES__POS)
+				attempts: -1,
+				interval: 0,
+			})).rejects.toThrow(MSG.ARG_ATTEMPTS__POS)
 		})
-		test('quit if `timeout` is not a number', async () => {
+		test('quit if `interval` is not a number', async () => {
 			expect.assertions(1)
 			await expect(retry(function () {}, {
-				retries: 1,
-				timeout: 'asd',
-			})).rejects.toThrow(MSG.ARG_TIMEOUT__NUM)
+				attempts: 1,
+				interval: 'asd',
+			})).rejects.toThrow(MSG.ARG_INTERVAL__NUM)
 		})
-		test('quit if `timeout` < 0', async () => {
+		test('quit if `interval` < 0', async () => {
 			expect.assertions(1)
 			await expect(retry(function () {}, {
-				retries: 1,
-				timeout: -123,
-			})).rejects.toThrow(MSG.ARG_TIMEOUT__POS)
+				attempts: 1,
+				interval: -123,
+			})).rejects.toThrow(MSG.ARG_INTERVAL__POS)
 		})
 	})
 
@@ -44,8 +44,8 @@ describe('retry()', () => {
 			await expect(retry(function () {
 				return true
 			}, {
-				retries: 1,
-				timeout: 0,
+				attempts: 1,
+				interval: 0,
 				debug: true,
 			})).resolves.toBeTruthy()
 		})
@@ -54,8 +54,8 @@ describe('retry()', () => {
 			await expect(retry(function () {
 				return false
 			}, {
-				retries: 1,
-				timeout: 0,
+				attempts: 1,
+				interval: 0,
 				debug: true,
 			})).rejects.toThrow()
 		})