-
-
Notifications
You must be signed in to change notification settings - Fork 102
/
clip.input.ts
58 lines (49 loc) · 1.33 KB
/
clip.input.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
import { type UserIdResolvable } from '@twurple/common';
import { type HelixPagination } from '../../utils/pagination/HelixPagination';
import { type HelixClipFilterType } from './clip.external';
/**
* Filters for clip queries.
*/
export interface HelixClipFilter {
/**
* The earliest date to find clips for.
*/
startDate?: string;
/**
* The latest date to find clips for.
*/
endDate?: string;
/**
* The featured flag the results should have.
*
* If not given, both featured and non-featured clips will be returned.
*/
isFeatured?: boolean;
}
/**
* @inheritDoc
*/
export interface HelixPaginatedClipFilter extends HelixClipFilter, HelixPagination {}
/** @private */
export interface HelixClipIdFilterPart {
filterType: HelixClipFilterType;
ids: string | string[];
userId?: string;
}
/** @private */
export interface HelixClipIdFilter extends HelixClipFilter, HelixClipIdFilterPart {}
/** @private */
export interface HelixPaginatedClipIdFilter extends HelixPaginatedClipFilter, HelixClipIdFilterPart {}
/**
* Parameters for creating a clip.
*/
export interface HelixClipCreateParams {
/**
* The broadcaster of which you want to create a clip.
*/
channel: UserIdResolvable;
/**
* Add a delay before the clip creation that accounts for the usual delay in the viewing experience.
*/
createAfterDelay?: boolean;
}