Global - Documentation

Type Definitions

AggregatedChapter :Object

Properties:

Name	Type	Description
`chapter`	String	Chapter number
`id`	String	Chapter UUID
`others`	Array.<String>
`count`	Number

Source:

typedefs/Queries.js, line 77

AggregatedVolume :Object

Properties:

Name	Type	Description
`volume`	String
`count`	Number
`chapters`	Object.<String, AggregatedChapter>

Source:

typedefs/Queries.js, line 67

Example

AggregatedVolume.chapters["1"] # Returns {AggregatedChapter} with code "1"

AuthorOrderOptions :Object

Properties:

Name	Type	Description
`name`	"asc" \| "desc"

Source:

typedefs/Queries.js, line 133

AuthorQuery :Object

Properties:

Name	Type	Attributes	Description
`name`	String	<optional>	Author's name
`order`	AuthorOrderOptions	<optional>	Order parameters
`includes`	Array.<String>	<optional>
`ids`	Array.<String>	<optional>	Author ids (Limited to 100 per request)

Source:

typedefs/Queries.js, line 124

ChapterOrderOptions :Object

Properties:

Name	Type	Attributes	Default
`createdAt`	"asc" \| "desc"	<optional>	"asc"
`updatedAt`	"asc" \| "desc"	<optional>	"asc"
`publishAt`	"asc" \| "desc"	<optional>	"asc"
`readableAt`	"asc" \| "desc"	<optional>	"asc"
`volume`	"asc" \| "desc"	<optional>	"asc"
`chapter`	"asc" \| "desc"	<optional>	"asc"

Source:

typedefs/Queries.js, line 86

ChapterQuery :Object

Properties:

Name	Type	Attributes	Default	Description
`ids`	Array.<String>			Limited to 100
`title`	String	<optional>
`groups`	Array.<String>	<optional>
`uploader`	Array.<String>	<optional>		Uploader UUIDs
`manga`	String	<optional>		Manga UUID
`volume`	Array.<String> \| String	<optional>
`chapter`	Array.<String>	<optional>
`translatedLanguage`	Array.<String>	<optional>
`originalLanguage`	Array.<String>	<optional>
`excludedOriginalLanguage`	Array.<String>	<optional>
`contentRating`	Array.<contentRating>	<optional>	["safe","suggestive","erotica"]
`excludedGroups`	Array.<String>	<optional>
`excludedUploaders`	Array.<String>	<optional>
`includeFutureUpdates`	"1" \| "0"	<optional>	"1"
`includeEmptyPages`	1 \| 0	<optional>
`includeFuturePublishAt`	1 \| 0	<optional>
`includeExternalUrl`	1 \| 0	<optional>
`createdAtSince`	String	<optional>
`updatedAtSince`	String	<optional>
`publishAtSince`	String	<optional>
`order`	ChapterOrderOptions	<optional>
`includes`	Array.<String>	<optional>		Available values : manga, scanlation_group, user

Source:

typedefs/Queries.js, line 97

CoverArtOrder :Object

Properties:

Name	Type	Description
`createdAt`	"asc" \| "desc"
`updatedAt`	"asc" \| "desc"
`volume`	"asc" \| "desc"

Source:

typedefs/Queries.js, line 150

CoverArtQuery :Object

Properties:

Name	Type	Description
`manga`	Array.<String>	Manga ids (limited to 100 per request)
`ids`	Array.<String>	Covers ids (limited to 100 per request)
`uploaders`	Array.<String>	User ids (limited to 100 per request)
`locales`	Array.<String>	Locales of cover art (limited to 100 per request)
`order`	CoverArtOrder
`includes`	Array.<String>

Source:

typedefs/Queries.js, line 139

LanguageCode :"aa"|"ab"|"af"|"am"|"ar"|"as"|"ay"|"az"|"ba"|"be"|"bg"|"bh"|"bi"|"bn"|"bo"|"br"|"ca"|"co"|"cs"|"cy"|"da"|"de"|"dz"|"el"|"en"|"eo"|"es"|"et"|"eu"|"fa"|"fi"|"fj"|"fo"|"fr"|"fy"|"ga"|"gd"|"gl"|"gn"|"gu"|"ha"|"hi"|"hr"|"hu"|"hy"|"ia"|"ie"|"ik"|"in"|"is"|"it"|"iw"|"ja"|"ji"|"jw"|"ka"|"kk"|"kl"|"km"|"kn"|"ko"|"ks"|"ku"|"ky"|"la"|"ln"|"lo"|"lt"|"lv"|"mg"|"mi"|"mk"|"ml"|"mn"|"mo"|"mr"|"ms"|"mt"|"my"|"na"|"ne"|"nl"|"no"|"oc"|"om"|"or"|"pa"|"pl"|"ps"|"pt"|"qu"|"rm"|"rn"|"ro"|"ru"|"rw"|"sa"|"sd"|"sg"|"sh"|"si"|"sk"|"sl"|"sm"|"sn"|"so"|"sq"|"sr"|"ss"|"st"|"su"|"sv"|"sw"|"ta"|"te"|"tg"|"th"|"ti"|"tk"|"tl"|"tn"|"to"|"tr"|"ts"|"tt"|"tw"|"ug"|"uk"|"ur"|"uz"|"vi"|"vo"|"wo"|"xh"|"yi"|"yo"|"za"|"zh"|"zu"

Source:

typedefs/Enums.js, line 16

LocalizedString :Object.<LanguageCode, String>

Source:

typedefs/Enums.js, line 21

Example

Object.en # -> returns "Apple"
Object.de # -> returns "Apfel"

MangaAggregateQuery :Object

Properties:

Name	Type	Description
`translatedLanguage`	Array.<LanguageCode>
`groups`	Array.<String>	Group UUIDs

Source:

typedefs/Queries.js, line 60

MangaFeedQuery :Object

Properties:

Name	Type	Attributes	Default
`translatedLanguage`	Array.<String>	<optional>
`originalLanguage`	Array.<String>	<optional>
`excludedOriginalLanguage`	Array.<String>	<optional>
`contentRating`	Array.<contentRating>	<optional>
`excludedGroups`	Array.<String>	<optional>
`excludedUploaders`	Array.<String>	<optional>
`includeFutureUpdates`	"1" \| "0"	<optional>	1
`createdAtSince`	String	<optional>
`updatedAtSince`	String	<optional>
`publishAtSince`	String	<optional>
`order`	MangaOrderOptions	<optional>
`includes`	Array.<String>	<optional>
`includeEmptyPages`	0 \| 1	<optional>
`includeFuturePublishAt`	0 \| 1	<optional>
`includeExternalUrl`	0 \| 1	<optional>

Source:

typedefs/Queries.js, line 40

MangaOrderOptions :Object

Properties:

Name	Type	Attributes	Default
`title`	"asc" \| "desc"	<optional>
`year`	"asc" \| "desc"	<optional>
`createdAt`	"asc" \| "desc"	<optional>
`updatedAt`	"asc" \| "desc"	<optional>
`latestUploadedChapter`	"asc" \| "desc"	<optional>	"desc"
`followedCount`	"asc" \| "desc"	<optional>
`relevance`	"asc" \| "desc"	<optional>

Source:

typedefs/Queries.js, line 1

MangaQuery :Object

Properties:

Name	Type	Attributes	Default	Description
`title`	String	<optional>
`authorOrArtist`	String	<optional>		Author/Artist ID
`authors`	Array.<String>	<optional>
`artists`	Array.<String>	<optional>
`year`	Number	<optional>
`includedTags`	Array.<String>	<optional>
`includedTagsMode`	String	<optional>	"AND"	Avaliale values: AND, OR
`excludedTags`	Array.<String>	<optional>
`excludedTagsMode`	String	<optional>	"OR"	Avaliable values: AND, OR
`status`	Array.<mangaStatus>	<optional>		Avaliable values: "ongoing", "completed", "hiatus", "cancelled"
`originalLanguage`	Array.<String>	<optional>
`excludedOriginalLanguage`	Array.<String>	<optional>
`availableTranslatedLanguage`	Array.<String>	<optional>
`publicationDemographic`	Array.<publicationDemographic>	<optional>
`ids`	Array.<String>	<optional>		Manga ids (limited to 100 per request)
`contentRating`	Array.<contentRating>	<optional>	["safe", "suggestive", "erotica"]
`createdAtSince`	String	<optional>
`updatedAtSince`	String	<optional>
`order`	MangaOrderOptions	<optional>
`includes`	Array.<String>	<optional>		Available values: "manga", "artist", "tag", "author", "creator", "cover_art"
`hasAvaliableChapters`	String	<optional>		Available values: "0", "1", "true", "false"
`group`	String	<optional>		Group ID

Source:

typedefs/Queries.js, line 13

MangaTag :Object

Properties:

Name	Type	Description
`id`	String	Tag ID
`type`	String	Value = "tag"
`attributes`	TagAttributes	Tag attributes
`relationships`	Array.<Relationship>	Relationships

Source:

typedefs/Attributes.js, line 9

Relationship :Object

Properties:

Name	Type	Description
`id`	String	ID
`type`	String
`related`	String	Enum: "monochrome" "main_story" "adapted_from" "based_on" "prequel" "side_story" "doujinshi" "same_franchise" "shared_universe" "sequel" "spin_off" "alternate_story" "alternate_version" "preserialization" "colored" "serialization" "author" "cover" "artist"
`attributes`	Object

Source:

typedefs/Attributes.js, line 1

TagAttributes :Object

Properties:

Name	Type	Description
`name`	LocalizedString	Name
`description`	LocalizedString	Description
`group`	String	"content", "format", "genre", "theme"
`version`	Number	Integer >= 1

Source:

typedefs/Attributes.js, line 17

contentRating :"safe"|"suggestive"|"erotica"|"pornographic"

Source:

typedefs/Enums.js, line 11

mangaState :"draft"|"submitted"|"published"|"rejected"

Source:

typedefs/Enums.js, line 29

mangaStatus :"ongoing"|"hiatus"|"completed"|"cancelled"

Source:

typedefs/Enums.js, line 6

publicationDemographic :"shounen"|"shoujo"|"josei"|"seinen"|"none"

Source:

typedefs/Enums.js, line 1