-
Notifications
You must be signed in to change notification settings - Fork 18
/
SiteInfo.ts
32 lines (30 loc) · 939 Bytes
/
SiteInfo.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
/**
* @packageDocumentation
* @module Structures
*/
import SiteApi from './SiteApi'
/**
* Represents the info needed to create a new {@link Site}
* <p>Same properties as {@link Site}, but some optional</p>
* <p>Mostly just here to reflect what sites.json should look like
*/
export default interface SiteInfo {
/** The domain of the Site (the "google.com" part of "https://google.com/foo") */
domain: string
/** The type of this site (json/xml/derpi) */
type: string
/** The aliases of this site */
aliases: string[]
/** If this site serves NSFW posts or not */
nsfw: boolean
/** An object representing the api of this site */
api: SiteApi
/** The url query param to paginate on the site */
paginate?: string
/** If the site supports `order:random` */
random: boolean | string
/** The url query param for tags */
tagQuery?: string
/** If this site supports only http:// */
insecure?: boolean
}