Skip to content

Commit 91d8645

Browse files
committed
Add JSDoc comments on webhook user interfaces
1 parent 2bf2f3f commit 91d8645

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

payloads/v1/webhooks.ts

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
import type {Emote} from './emote';
22

3+
/**
4+
* Represents a user in the context of most of Kick's webhook events,
5+
* specifically those that include the is_anonymous field.
6+
*
7+
* @see WebhookBaseUser
8+
*/
39
export interface WebhookUser extends WebhookBaseUser {
410
is_anonymous: boolean;
511
}
@@ -27,10 +33,13 @@ export interface WebhookUserWithIdentity extends WebhookUser {
2733
identity: WebhookIdentity;
2834
}
2935

30-
export interface KicksGiftedWebhookUser extends WebhookBaseUser {
31-
// This type is used specifically for kicks.gifted events where Kick's API
32-
// does not provide the is_anonymous field that other webhook events have
33-
}
36+
/**
37+
* Represents a user in the context of a "kicks gifted" webhook event. Kick's
38+
* API does not provide the is_anonymous field that other webhook events have.
39+
*
40+
* @see WebhookBaseUser
41+
*/
42+
export interface KicksGiftedWebhookUser extends WebhookBaseUser {}
3443

3544
export interface WebhookRepliesTo {
3645
message_id: string;

0 commit comments

Comments
 (0)