ami/tl-vikunja
1
0
Fork 0
Code

chore(services): add examples for some functions

Browse Source
This commit is contained in:
WofWca 2023-03-02 15:04:39 +04:00 committed by kolaente
parent 149ceaf2e5
commit 5f9485414b
No known key found for this signature in database
GPG Key ID: F40E70337AB24C9B
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/services/abstractService.ts
View File

@ -126,6 +126,12 @@ export default abstract class AbstractService<Model extends IAbstract = IAbstrac
/** /**
* Returns an object with all route parameters and their values. * 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> = {}) { getRouteReplacements(route : string, parameters : Record<string, unknown> = {}) {
const replace$$1: 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. * 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 { getReplacedRoute(path : string, pathparams : Record<string, unknown>) : string {
const replacements = this.getRouteReplacements(path, pathparams) const replacements = this.getRouteReplacements(path, pathparams)