From 5f9485414b17729cbf692699c06f5ff6d638c25a Mon Sep 17 00:00:00 2001
From: WofWca <wofwca@protonmail.com>
Date: Thu, 2 Mar 2023 15:04:39 +0400
Subject: [PATCH] chore(services): add examples for some functions

---
 src/services/abstractService.ts | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/src/services/abstractService.ts b/src/services/abstractService.ts
index 41d789433..e108667d1 100644
--- a/src/services/abstractService.ts
+++ b/src/services/abstractService.ts
@@ -126,6 +126,12 @@ export default abstract class AbstractService<Model extends IAbstract = IAbstrac
 
 	/**
 	 * Returns an object with all route parameters and their values.
+	 * @example
+	 * getRouteReplacements(
+	 * 	'/tasks/{taskId}/assignees/{userId}',
+	 * 	{ taskId: 7, userId: 2 },
+	 * )
+	 * // { "{taskId}": 7, "{userId}": 2 }
 	 */
 	getRouteReplacements(route : string, parameters : Record<string, unknown> = {}) {
 		const replace$$1: Record<string, unknown> = {}
@@ -148,6 +154,8 @@ export default abstract class AbstractService<Model extends IAbstract = IAbstrac
 
 	/**
 	 * Returns a fully-ready-ready-to-make-a-request-to route with replaced parameters.
+	 * @example
+	 * getReplacedRoute('/lists/{listId}/tasks', { listId: 3 }) === '/lists/1/tasks'
 	 */
 	getReplacedRoute(path : string, pathparams : Record<string, unknown>) : string {
 		const replacements = this.getRouteReplacements(path, pathparams)