aboutsummaryrefslogtreecommitdiffhomepage
path: root/packages/models/src/search/videos-common-query.model.ts
diff options
context:
space:
mode:
Diffstat (limited to 'packages/models/src/search/videos-common-query.model.ts')
-rw-r--r--packages/models/src/search/videos-common-query.model.ts45
1 files changed, 45 insertions, 0 deletions
diff --git a/packages/models/src/search/videos-common-query.model.ts b/packages/models/src/search/videos-common-query.model.ts
new file mode 100644
index 000000000..45181a739
--- /dev/null
+++ b/packages/models/src/search/videos-common-query.model.ts
@@ -0,0 +1,45 @@
1import { VideoIncludeType } from '../videos/video-include.enum.js'
2import { VideoPrivacyType } from '../videos/video-privacy.enum.js'
3import { BooleanBothQuery } from './boolean-both-query.model.js'
4
5// These query parameters can be used with any endpoint that list videos
6export interface VideosCommonQuery {
7 start?: number
8 count?: number
9 sort?: string
10
11 nsfw?: BooleanBothQuery
12
13 isLive?: boolean
14
15 isLocal?: boolean
16 include?: VideoIncludeType
17
18 categoryOneOf?: number[]
19
20 licenceOneOf?: number[]
21
22 languageOneOf?: string[]
23
24 privacyOneOf?: VideoPrivacyType[]
25
26 tagsOneOf?: string[]
27 tagsAllOf?: string[]
28
29 hasHLSFiles?: boolean
30
31 hasWebtorrentFiles?: boolean // TODO: remove in v7
32 hasWebVideoFiles?: boolean
33
34 skipCount?: boolean
35
36 search?: string
37
38 excludeAlreadyWatched?: boolean
39}
40
41export interface VideosCommonQueryAfterSanitize extends VideosCommonQuery {
42 start: number
43 count: number
44 sort: string
45}