docs: add documentation and types

metcoder95 · metcoder95 · commit 917f5aea700e · 2024-04-25T10:17:04.000+02:00
diff --git a/docs/docs/api/RetryHandler.md b/docs/docs/api/RetryHandler.md
@@ -29,6 +29,7 @@ Extends: [`Dispatch.DispatchOptions`](Dispatcher.md#parameter-dispatchoptions).
 - **methods** `string[]` (optional) - Array of HTTP methods to retry. Default: `['GET', 'PUT', 'HEAD', 'OPTIONS', 'DELETE']`
 - **statusCodes** `number[]` (optional) - Array of HTTP status codes to retry. Default: `[429, 500, 502, 503, 504]`
 - **errorCodes** `string[]` (optional) - Array of Error codes to retry. Default: `['ECONNRESET', 'ECONNREFUSED', 'ENOTFOUND', 'ENETDOWN','ENETUNREACH', 'EHOSTDOWN', 'UND_ERR_SOCKET']`
+- **ifMatch** `boolean` (optional) - It enables the send of `if-match` pre-condition header if `etag` is present in the first response. Default: `true`
 
 **`RetryContext`**
 
diff --git a/test/types/retry-agent.test-d.ts b/test/types/retry-agent.test-d.ts
@@ -4,7 +4,7 @@ import { RetryAgent, Agent } from '../..'
 const dispatcher = new Agent()
 
 expectAssignable<RetryAgent>(new RetryAgent(dispatcher))
-expectAssignable<RetryAgent>(new RetryAgent(dispatcher, { maxRetries: 5 }))
+expectAssignable<RetryAgent>(new RetryAgent(dispatcher, { maxRetries: 5, ifMatch: false }))
 
 {
   const retryAgent = new RetryAgent(dispatcher)
diff --git a/types/retry-handler.d.ts b/types/retry-handler.d.ts
@@ -107,6 +107,13 @@ declare namespace RetryHandler {
      * @default [500, 502, 503, 504, 429],
      */
     statusCodes?: number[];
+    /**
+     * Enables/disabled the usage of `If-Match` pre-condition header for retry requests.
+     * @type {boolean}
+     * @memberof RetryOptions
+     * @default true
+     */
+    ifMatch?: boolean;
   }
 
   export interface RetryHandlers {

Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import { RetryAgent, Agent } from '../..'`
`4`	`4`	`const dispatcher = new Agent()`
`5`	`5`
`6`	`6`	`expectAssignable<RetryAgent>(new RetryAgent(dispatcher))`
`7`		`-expectAssignable<RetryAgent>(new RetryAgent(dispatcher, { maxRetries: 5 }))`
	`7`	`+expectAssignable<RetryAgent>(new RetryAgent(dispatcher, { maxRetries: 5, ifMatch: false }))`
`8`	`8`
`9`	`9`	`{`
`10`	`10`	`const retryAgent = new RetryAgent(dispatcher)`