From 9ee59d13376c25da0028922009839f790be13648 Mon Sep 17 00:00:00 2001
From: doge <shadowphoenixcoc@gmail.com>
Date: Mon, 12 Apr 2021 09:22:13 -0400
Subject: [PATCH] docs: document abort controllers

Co-authored-by: Tyler J Russell <22531310+Nytelife26@users.noreply.github.com>
---
 src/lib/PetitioRequest.ts | 8 +++++++-
 1 file changed, 7 insertions(+), 1 deletion(-)

diff --git a/src/lib/PetitioRequest.ts b/src/lib/PetitioRequest.ts
index 0003765..5b47b83 100644
--- a/src/lib/PetitioRequest.ts
+++ b/src/lib/PetitioRequest.ts
@@ -135,8 +135,14 @@ export class PetitioRequest {
 		return this;
 	}
 	/**
-	 * @param {AbortController} controller A AbortController to potentially abort the request.
+	 * @param {AbortController} controller A controller instance that handles aborting the request.
 	 * @return {*} The request object for further composition.
+	 * @example
+	 * ```ts
+	 * const controller = new AbortController();
+	 * const result = petitio(URL).signal(controller);
+	 * setTimeout(() => controller.abort(), 5000) // serves as a request timeout
+	 * ```
 	 */
 	public signal(controller: AbortController): this {
 		this.controller = controller;