lissa 1.0.2 → 1.0.4

package/README.md

@@ -478,8 +478,9 @@ Decide if the occurred error should trigger a retry.
 The given errorType helps preselecting error types. Return false to not
 trigger a retry. Return nothing if the given errorType is correct. Return
 a string to redefine the errorType or use a custom one. The number of
-maximum retries can be configured as `on${errorType}`. Return "CustomError"
-and define the retries as { onCustomError: 3 }
+maximum retries can be configured as `on${errorType}` or `@${errorType}`.
+Return "CustomError" and define the retries as { onCustomError: 3 } or
+as { '@CustomError': 3 }.
 
 ```js
 Lissa.retry({

package/lib/index.d.ts

@@ -317,14 +317,14 @@ export interface Lissa extends MakeRequest {
 	 *
 	 * Modify the given options as argument or return a new options object.
 	 */
-	beforeRequest(hook: (options: LissaOptions) => void | LissaOptions): Lissa;
+	beforeRequest(hook: (options: LissaOptions) => void | LissaOptions | Promise<void | LissaOptions>): Lissa;
 
 	/**
 	 * Add a beforeFetch hook into the request cycle.
 	 *
 	 * Modify the actual fetch arguments or return new arguments.
 	 */
-	beforeFetch(hook: (request: FetchArguments) => void | FetchArguments): Lissa;
+	beforeFetch(hook: (request: FetchArguments) => void | FetchArguments | Promise<void | FetchArguments>): Lissa;
 
 	/**
 	 * Add an onResponse hook into the request cycle.
@@ -333,7 +333,7 @@ export interface Lissa extends MakeRequest {
 	 * stop looping over existing hooks and instantly returns this value (if it
 	 * is an instance of Error it will get thrown).
 	 */
-	onResponse(hook: (result: LissaResult) => void | Exclude<any, undefined>): Lissa;
+	onResponse(hook: (result: LissaResult) => void | Exclude<any, undefined> | Promise<void | Exclude<any, undefined>>): Lissa;
 
 	/**
 	 * Add an onError hook into the request cycle.
@@ -342,7 +342,7 @@ export interface Lissa extends MakeRequest {
 	 * over existing hooks and instantly returns this value (if it is an instance
 	 * of Error it will get thrown).
 	 */
-	onError(hook: (error: ResponseError | ConnectionError | GeneralErrorResponse) => void | Exclude<any, undefined>): Lissa;
+	onError(hook: (error: ResponseError | ConnectionError | GeneralErrorResponse) => void | Exclude<any, undefined> | Promise<void | Exclude<any, undefined>>): Lissa;
 
 	/**
 	 * Copy the current instance with all its options and hooks.
@@ -421,14 +421,14 @@ export declare const retry: (options?: RetryOptions) => Plugin;
 
 export type CustomRetryError = {
 	/** custom retry type have to be returned by shouldRetry hook */
-	[K in `on${string}`]: number;
+	[K in `@${string}`]: number;
 };
 
 export type RetryOptions = CustomRetryError & {
-	onConnectionError?: number;
-	onGatewayError?: number;
-	on429?: number;
-	onServerError?: number;
+	'@ConnectionError'?: number;
+	'@GatewayError'?: number;
+	'@429'?: number;
+	'@ServerError'?: number;
 
 	/**
 	 * Decide if the occurred error should trigger a retry.
@@ -436,8 +436,9 @@ export type RetryOptions = CustomRetryError & {
 	 * The given errorType helps preselecting error types. Return false to not
 	 * trigger a retry. Return nothing if the given errorType is correct. Return
 	 * a string to redefine the errorType or use a custom one. The number of
-	 * maximum retries can be configured as `on${errorType}`. Return "CustomError"
-	 * and define the retries as { onCustomError: 3 }
+	 * maximum retries can be configured as `on${errorType}` or `@${errorType}`.
+	 * Return "CustomError" and define the retries as { onCustomError: 3 } or
+	 * as { '@CustomError': 3 }.
 	 */
 	shouldRetry?: (
 		errorType: void | 'ConnectionError' | 'GatewayError' | '429' | 'ServerError',

package/lib/plugins/retry.js

@@ -42,7 +42,7 @@ export default (options = {}) => (lissa) => {
 		}
 
 		// Return nothing to hand over the error to the next onError hook
-		if (retry.attempt > (options[`on${errorType}`] || 0)) return;
+		if (retry.attempt > (options[`@${errorType}`] ?? options[`on${errorType}`] ?? 0)) return;
 
 		await new Promise(resolve => setTimeout(resolve, retry.delay));
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lissa",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "description": "A lightweight, extensible HTTP client for modern JavaScript applications with fluent api syntax, hooks, plugins and more.",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",