refactor(data): rename @params to @param to remove jsdoc warning (#1817)

Closes #1812
ngrx · May 5, 2019 · e1fae9e · e1fae9e
1 parent 18f382b
commit e1fae9e
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/modules/data/src/dispatchers/entity-commands.ts b/modules/data/src/dispatchers/entity-commands.ts
@@ -72,7 +72,7 @@ export interface EntityServerCommands<T> {
    * Dispatch action to query remote storage for the entities that satisfy a query expressed
    * with either a query parameter map or an HTTP URL query string,
    * and merge the results into the cached collection.
-   * @params queryParams the query in a form understood by the server
+   * @param queryParams the query in a form understood by the server
    * @param [options] options that influence merge behavior
    * @returns A terminating Observable of the queried entities
    * after server reports successful query or the query error.

diff --git a/modules/data/src/dispatchers/entity-dispatcher-base.ts b/modules/data/src/dispatchers/entity-dispatcher-base.ts
@@ -270,7 +270,7 @@ export class EntityDispatcherBase<T> implements EntityDispatcher<T> {
    * Dispatch action to query remote storage for the entities that satisfy a query expressed
    * with either a query parameter map or an HTTP URL query string,
    * and merge the results into the cached collection.
-   * @params queryParams the query in a form understood by the server
+   * @param queryParams the query in a form understood by the server
    * @returns A terminating Observable of the queried entities
    * after server reports successful query or the query error.
    */

diff --git a/modules/data/src/entity-services/entity-collection-service-base.ts b/modules/data/src/entity-services/entity-collection-service-base.ts
@@ -218,7 +218,7 @@ export class EntityCollectionServiceBase<
    * Dispatch action to query remote storage for the entities that satisfy a query expressed
    * with either a query parameter map or an HTTP URL query string,
    * and merge the results into the cached collection.
-   * @params queryParams the query in a form understood by the server
+   * @param queryParams the query in a form understood by the server
    * @param [options] options that influence merge behavior
    * @returns Observable of the queried entities
    * after server reports successful query or the query error.