From 549302e9c02c6f9e1dc60828425f637b78d453d8 Mon Sep 17 00:00:00 2001 From: Francis Dinh Date: Thu, 22 Dec 2022 16:54:55 -0500 Subject: [PATCH] server: add doc for createFollowRequest --- packages/backend/src/services/following/requests/create.ts | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/packages/backend/src/services/following/requests/create.ts b/packages/backend/src/services/following/requests/create.ts index bfcc2fd5e..81fec5fe4 100644 --- a/packages/backend/src/services/following/requests/create.ts +++ b/packages/backend/src/services/following/requests/create.ts @@ -7,6 +7,12 @@ import { Blockings, FollowRequests, Users } from '@/models/index.js'; import { genId } from '@/misc/gen-id.js'; import { createNotification } from '@/services/create-notification.js'; +/** + * Make a follow request from `follower` to `followee`. + * @param follower User making the follow request + * @param followee User to make the follow request to + * @param requestId Follow request ID + */ export async function createFollowRequest(follower: User, followee: User, requestId?: string): Promise { if (follower.id === followee.id) return;