Skip to content

Commit

Permalink
Fix types in docblock
Browse files Browse the repository at this point in the history
  • Loading branch information
redaxmedia committed Oct 1, 2021
1 parent 82396da commit 22354c3
Show file tree
Hide file tree
Showing 21 changed files with 217 additions and 215 deletions.
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -45,7 +45,7 @@
"chai": "4.3.4",
"core-js": "3.17.3",
"eslint": "7.26.0",
"eslint-config-redaxmedia": "3.0.0",
"eslint-config-redaxmedia": "3.1.0",
"jsdom": "17.0.0",
"jsdom-global": "3.0.2",
"mocha": "9.1.1",
Expand Down
12 changes: 6 additions & 6 deletions src/abort.interceptor.ts
Expand Up @@ -23,10 +23,10 @@ export class AbortInterceptor implements HttpInterceptor
*
* @since 4.0.0
*
* @param request instance of the http request
* @param next instance of the http handler
* @param {HttpRequest<T>} request instance of the http request
* @param {HttpHandler} next instance of the http handler
*
* @return http event as observable
* @return {Observable<HttpEvent<T>>} http event
*/

public intercept<T>(request : HttpRequest<T>, next : HttpHandler) : Observable<HttpEvent<T>>
Expand All @@ -42,10 +42,10 @@ export class AbortInterceptor implements HttpInterceptor
*
* @since 4.0.0
*
* @param request instance of the http request
* @param next instance of the http handler
* @param {HttpRequest<T>} request instance of the http request
* @param {HttpHandler} next instance of the http handler
*
* @return http event as observable
* @return {Observable<HttpEvent<T>>} http event
*/

public handle<T>(request : HttpRequest<T>, next : HttpHandler) : Observable<HttpEvent<T>>
Expand Down
26 changes: 13 additions & 13 deletions src/abort.service.ts
Expand Up @@ -19,7 +19,7 @@ export class AbortService
*
* @since 6.0.0
*
* @return token of the context
* @return {HttpContextToken<ContextInterface>} token of the context
*/

public getToken() : HttpContextToken<ContextInterface>
Expand All @@ -32,9 +32,9 @@ export class AbortService
*
* @since 4.0.0
*
* @param request instance of the http request
* @param {HttpRequest<T>} request instance of the http request
*
* @return signal as observable
* @return {Observable<boolean>} signal of the request
*/

public get<T>(request : HttpRequest<T>) : Observable<boolean>
Expand All @@ -51,9 +51,9 @@ export class AbortService
*
* @since 4.0.0
*
* @param request instance of the http request
* @param {HttpRequest<T>} request instance of the http request
*
* @return instance of the service
* @return {this} instance of the service
*/

public set<T>(request : HttpRequest<T>) : this
Expand All @@ -78,9 +78,9 @@ export class AbortService
*
* @since 4.0.0
*
* @param request instance of the http request
* @param {HttpRequest<T>} request instance of the http request
*
* @return boolean
* @return {boolean}
*/

public has<T>(request : HttpRequest<T>) : boolean
Expand All @@ -93,9 +93,9 @@ export class AbortService
*
* @since 4.0.0
*
* @param urlWithParams url with parameters
* @param {string} urlWithParams url with parameters
*
* @return instance of the service
* @return {this} instance of the service
*/

public abort(urlWithParams : string) : this
Expand All @@ -114,9 +114,9 @@ export class AbortService
*
* @since 4.1.0
*
* @param url url of the request
* @param {string} url url of the request
*
* @return instance of the service
* @return {this} instance of the service
*/

public abortMany(url : string) : this
Expand All @@ -130,7 +130,7 @@ export class AbortService
*
* @since 4.0.0
*
* @return instance of the service
* @return {this} instance of the service
*/

public abortAll() : this
Expand All @@ -144,7 +144,7 @@ export class AbortService
*
* @since 4.1.0
*
* @return collection of signal and timeout as observable
* @return {Observable<[string, StoreInterface]>} collection of signal and timeout
*/

public observeAll() : Observable<[string, StoreInterface]>
Expand Down
4 changes: 2 additions & 2 deletions src/batch.service.ts
Expand Up @@ -10,9 +10,9 @@ export class BatchService<T> extends CommonService
*
* @since 4.2.0
*
* @param requestArray collection of requests
* @param {ObservableInput<T>[]} requestArray collection of requests
*
* @return multiple http responses as observable
* @return {Observable<T[]>} multiple http responses
*/

public parallel(requestArray : ObservableInput<T>[]) : Observable<T[]>
Expand Down
18 changes: 9 additions & 9 deletions src/cache.interceptor.ts
Expand Up @@ -24,10 +24,10 @@ export class CacheInterceptor implements HttpInterceptor
*
* @since 3.0.0
*
* @param request instance of the http request
* @param next instance of the http handler
* @param {HttpRequest<T>} request instance of the http request
* @param {HttpHandler} next instance of the http handler
*
* @return http event as observable
* @return {Observable<HttpEvent<T>>} http event
*/

public intercept<T>(request : HttpRequest<T>, next : HttpHandler) : Observable<HttpEvent<T>>
Expand All @@ -43,10 +43,10 @@ export class CacheInterceptor implements HttpInterceptor
*
* @since 3.0.0
*
* @param request instance of the http request
* @param next instance of the http handler
* @param {HttpRequest<T>} request instance of the http request
* @param {HttpHandler} next instance of the http handler
*
* @return http event as observable
* @return {Observable<HttpEvent<T>>} http event
*/

protected handle<T>(request : HttpRequest<T>, next : HttpHandler) : Observable<HttpEvent<T>>
Expand All @@ -59,10 +59,10 @@ export class CacheInterceptor implements HttpInterceptor
*
* @since 3.0.0
*
* @param request instance of the http request
* @param next instance of the http handler
* @param {HttpRequest<T>} request instance of the http request
* @param {HttpHandler} next instance of the http handler
*
* @return http response as observable
* @return {Observable<HttpResponse<T>>} http response
*/

protected store<T>(request : HttpRequest<T>, next : HttpHandler) : Observable<HttpResponse<T>>
Expand Down
28 changes: 14 additions & 14 deletions src/cache.service.ts
Expand Up @@ -19,7 +19,7 @@ export class CacheService
*
* @since 6.0.0
*
* @return token of the context
* @return {HttpContextToken<ContextInterface>} token of the context
*/

public getToken() : HttpContextToken<ContextInterface>
Expand All @@ -32,9 +32,9 @@ export class CacheService
*
* @since 3.0.0
*
* @param request instance of the http request
* @param {HttpRequest<T>} request instance of the http request
*
* @return http response as observable
* @return {Observable<HttpResponse<T>>} http response
*/

public get<T>(request : HttpRequest<T>) : Observable<HttpResponse<T>>
Expand All @@ -51,10 +51,10 @@ export class CacheService
*
* @since 3.0.0
*
* @param request instance of the http request
* @param response instance of the http response
* @param {HttpRequest<T>} request instance of the http request
* @param {Observable<HttpResponse<T>>} response instance of the http response
*
* @return instance of the service
* @return {this} instance of the service
*/

public set<T>(request : HttpRequest<T>, response : Observable<HttpResponse<T>>) : this
Expand All @@ -78,9 +78,9 @@ export class CacheService
*
* @since 3.0.0
*
* @param request instance of the http request
* @param {HttpRequest<T>} request instance of the http request
*
* @return boolean
* @return {boolean}
*/

public has<T>(request : HttpRequest<T>) : boolean
Expand All @@ -93,9 +93,9 @@ export class CacheService
*
* @since 3.0.0
*
* @param urlWithParams url with parameters
* @param {string} urlWithParams url with parameters
*
* @return instance of the service
* @return {this} instance of the service
*/

public flush(urlWithParams : string) : this
Expand All @@ -113,9 +113,9 @@ export class CacheService
*
* @since 4.1.0
*
* @param url url of the request
* @param {string} url url of the request
*
* @return instance of the service
* @return {this} instance of the service
*/

public flushMany(url : string) : this
Expand All @@ -129,7 +129,7 @@ export class CacheService
*
* @since 3.0.0
*
* @return instance of the service
* @return {this} instance of the service
*/

public flushAll() : this
Expand All @@ -143,7 +143,7 @@ export class CacheService
*
* @since 4.1.0
*
* @return collection of response and timeout as observable
* @return {Observable<[string, StoreInterface]>} collection of response and timeout
*/

public observeAll() : Observable<[string, StoreInterface]>
Expand Down

0 comments on commit 22354c3

Please sign in to comment.