Skip to content

Commit

Permalink
chore: Fix JSDoc types declarations for optional params
Browse files Browse the repository at this point in the history
  • Loading branch information
Ldoppea authored and Crash-- committed Sep 22, 2022
1 parent 097709e commit 2d7e643
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions packages/cozy-stack-client/src/FileCollection.js
Original file line number Diff line number Diff line change
Expand Up @@ -1053,10 +1053,10 @@ class FileCollection extends DocumentCollection {
* async findNotSynchronizedDirectories - Returns the list of directories not synchronized on the given OAuth client (mainly Cozy Desktop clients) — see https://docs.cozy.io/en/cozy-stack/not-synchronized-vfs/#get-datatypedoc-idrelationshipsnot_synchronizing
*
* @param {OAuthClient} oauthClient A JSON representing an OAuth client, with at least a `_type` and `_id` field.
* @param {object|null} options Pagination options
* @param {number|null} options.skip For skip-based pagination, the number of referenced files to skip.
* @param {number|null} options.limit For pagination, the number of results to return.
* @param {CouchDBViewCursor|null} options.cursor For cursor-based pagination, the index cursor.
* @param {object} [options] Pagination options
* @param {number} [options.skip] For skip-based pagination, the number of referenced files to skip.
* @param {number} [options.limit] For pagination, the number of results to return.
* @param {CouchDBViewCursor} [options.cursor] For cursor-based pagination, the index cursor.
* @param {boolean} options.includeFiles Include the whole file documents in the results list
*
* @returns {Promise<Array<object|IOCozyFolder>>} The JSON API conformant response.
Expand Down

0 comments on commit 2d7e643

Please sign in to comment.