From 4db25e4b1fb0126de796effae73670bf78091ab5 Mon Sep 17 00:00:00 2001 From: Francis Dinh Date: Thu, 22 Dec 2022 16:50:46 -0500 Subject: [PATCH] server: add doc for cancelFollowRequest --- packages/backend/src/services/following/requests/cancel.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/backend/src/services/following/requests/cancel.ts b/packages/backend/src/services/following/requests/cancel.ts index b3e64c4f4..999ebc64e 100644 --- a/packages/backend/src/services/following/requests/cancel.ts +++ b/packages/backend/src/services/following/requests/cancel.ts @@ -7,6 +7,11 @@ import { IdentifiableError } from '@/misc/identifiable-error.js'; import { User } from '@/models/entities/user.js'; import { Users, FollowRequests } from '@/models/index.js'; +/** + * Cancel a follow request from `follower` to `followee`. + * @param followee User that was going to be followed + * @param follower User who is making the follow request + */ export async function cancelFollowRequest(followee: User, follower: User): Promise { if (Users.isRemoteUser(followee)) { const content = renderActivity(renderUndo(renderFollow(follower, followee), follower));