Skip to content

Add JSDoc documentation on getResourceAccess func #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add JSDoc documentation on getResourceAccess func #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/api-tdx.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1609,7 +1609,12 @@ class TDXApi {

/**
* Gets all access the authenticated account has to the given resource id.
*
* @param {string} resourceId - The id of the resource whose access is to be retrieved.
* @param {object} [filter] - A mongodb filter definition.
* @param {object} [projection] - A mongodb projection definition, can be used to restrict which properties are
* returned thereby limiting the payload.
* @param {object} [options] - A mongodb options definition, can be used for limit, skip, sorting etc.
* @return {ResourceAccess[]} - Array of ResourceAccess objects.
* @example
* api.getResourceAccess(myResourceId)
Expand Down