Skip to content

Commit 4fd92ba

Browse files
docs: translate comments to English in rest/profile.ts and improve API endpoint documentation
1 parent 94036ce commit 4fd92ba

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

rest/profile.ts

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,13 @@ import type { FetchError } from "./robustFetch.ts";
1111
import { type BaseOptions, setDefaults } from "./options.ts";
1212

1313
export interface GetProfile {
14-
/** /api/users/me の要求を組み立てる
14+
/** Constructs a request for the /api/users/me endpoint
1515
*
16-
* @param init connect.sid etc.
17-
* @return request
16+
* This endpoint retrieves the current user's profile information,
17+
* which can be either a MemberUser or GuestUser profile.
18+
*
19+
* @param init Options including connect.sid (session ID) and other configuration
20+
* @return The constructed request object
1821
*/
1922
toRequest: (init?: BaseOptions) => Request;
2023

0 commit comments

Comments
 (0)