mirror of
https://github.com/wassname/talk.git
synced 2026-08-16 11:29:31 +08:00
fix jsdoc warnings (#2750)
This commit is contained in:
@@ -412,6 +412,8 @@ function cursorGetterFactory(
|
||||
* replies.
|
||||
*
|
||||
* @param mongo database connection
|
||||
* @param tenantID the tenant id
|
||||
* @param storyID the id of the story the comment belongs to
|
||||
* @param parentID the parent id for the comment to retrieve
|
||||
* @param input connection configuration
|
||||
*/
|
||||
@@ -437,7 +439,7 @@ export const retrieveCommentRepliesConnection = (
|
||||
*
|
||||
* @param mongo the database connection to use when retrieving comments
|
||||
* @param tenantID the tenant id for where the comment exists
|
||||
* @param commentID the id of the comment to retrieve parents of
|
||||
* @param comment the comment to retrieve parents of
|
||||
* @param pagination pagination options to paginate the results
|
||||
*/
|
||||
export async function retrieveCommentParentsConnection(
|
||||
@@ -507,6 +509,7 @@ export async function retrieveCommentParentsConnection(
|
||||
* comments.
|
||||
*
|
||||
* @param mongo database connection
|
||||
* @param tenantID the Tenant id
|
||||
* @param storyID the Story id for the comment to retrieve
|
||||
* @param input connection configuration
|
||||
*/
|
||||
@@ -763,6 +766,7 @@ export async function updateCommentStatus(
|
||||
* @param mongo the database handle
|
||||
* @param tenantID the id of the Tenant
|
||||
* @param id the id of the Comment being updated
|
||||
* @param revisionID the id of the Comment revision being updated
|
||||
* @param actionCounts the action counts to merge into the Comment
|
||||
*/
|
||||
export async function updateCommentActionCounts(
|
||||
|
||||
@@ -61,6 +61,7 @@ export type CreateTenantInput = Pick<
|
||||
* create will create a new Tenant.
|
||||
*
|
||||
* @param mongo the MongoDB connection used to create the tenant.
|
||||
* @param i18n i18n instance
|
||||
* @param input the customizable parts of the Tenant available during creation
|
||||
*/
|
||||
export async function createTenant(
|
||||
|
||||
@@ -1434,7 +1434,7 @@ export async function premodUser(
|
||||
* @param mongo the mongo database handle
|
||||
* @param tenantID the Tenant's ID where the User exists
|
||||
* @param id the ID of the user having their ban lifted
|
||||
* @param modifiedBy the ID of the user lifting the premod
|
||||
* @param createdBy the ID of the user lifting the premod
|
||||
* @param now the current date
|
||||
*/
|
||||
export async function removeUserPremod(
|
||||
@@ -1635,7 +1635,7 @@ export async function removeUserBan(
|
||||
* @param tenantID the Tenant's ID where the User exists
|
||||
* @param id the ID of the user being suspended
|
||||
* @param createdBy the ID of the user banning the above mentioned user
|
||||
* @param from the range of time that the user is being banned for
|
||||
* @param finish the date the suspension ends
|
||||
* @param message the message sent to suspended user in email
|
||||
* @param now the current date
|
||||
*/
|
||||
@@ -2335,6 +2335,7 @@ export async function pullUserNotificationDigests(
|
||||
* @param mongo the database to pull scheduled users to delete from
|
||||
* @param tenantID the tenant ID to pull users that have been scheduled for
|
||||
* deletion on
|
||||
* @param rescheduledDuration duration in which to reschedule
|
||||
* @param now the current time
|
||||
*/
|
||||
export async function retrieveUserScheduledForDeletion(
|
||||
|
||||
Reference in New Issue
Block a user