Search
Preparing search index...
The search index is not available
mangadex-api - v5.0.1
Options
All
Public
Public/Protected
All
Inherited
Menu
mangadex-api - v5.0.1
GroupResolver
Class GroupResolver
Hierarchy
ApiBase
GroupResolver
Index
Constructors
constructor
Properties
agent
options
Methods
get
Group
search
get
Group
search
Constructors
constructor
new
Group
Resolver
(
__namedParameters
:
{
agent
:
Agent
;
options
:
AgentOptions
}
)
:
GroupResolver
Parameters
__namedParameters:
{
agent
:
Agent
;
options
:
AgentOptions
}
agent
:
Agent
options
:
AgentOptions
Returns
GroupResolver
Properties
agent
agent
:
Agent
options
options
:
AgentOptions
Methods
get
Group
get
Group
(
groupId
:
string
, options
?:
{
withRelationShips
?:
false
}
)
:
Promise
<
GroupResponse
>
get
Group
(
groupId
:
string
, options
?:
{
withRelationShips
?:
true
}
)
:
Promise
<
GroupExtendedResponse
>
Parameters
groupId:
string
Optional
options:
{
withRelationShips
?:
false
}
Optional
with
Relation
Ships
?:
false
Returns
Promise
<
GroupResponse
>
Parameters
groupId:
string
Optional
options:
{
withRelationShips
?:
true
}
Optional
with
Relation
Ships
?:
true
Returns
Promise
<
GroupExtendedResponse
>
search
search
(
options
:
Partial
<
{
ids
:
string
[]
;
limit
:
number
;
name
:
string
;
offset
:
number
}
>
)
:
Promise
<
GroupList
>
Parameters
options:
Partial
<
{
ids
:
string
[]
;
limit
:
number
;
name
:
string
;
offset
:
number
}
>
Returns
Promise
<
GroupList
>
Static
get
Group
get
Group
(
groupId
:
string
, options
?:
{
withRelationShips
?:
false
}
)
:
Promise
<
GroupResponse
>
get
Group
(
groupId
:
string
, options
?:
{
withRelationShips
?:
true
}
)
:
Promise
<
GroupExtendedResponse
>
Parameters
groupId:
string
Optional
options:
{
withRelationShips
?:
false
}
Optional
with
Relation
Ships
?:
false
If true, will additionally fetch data in relationships. (user)
Returns
Promise
<
GroupResponse
>
Parameters
groupId:
string
Optional
options:
{
withRelationShips
?:
true
}
Optional
with
Relation
Ships
?:
true
If true, will additionally fetch data in relationships. (user)
Returns
Promise
<
GroupExtendedResponse
>
Static
search
search
(
options
:
Partial
<
{
ids
:
string
[]
;
limit
:
number
;
name
:
string
;
offset
:
number
}
>
)
:
Promise
<
GroupList
>
Parameters
options:
Partial
<
{
ids
:
string
[]
;
limit
:
number
;
name
:
string
;
offset
:
number
}
>
Returns
Promise
<
GroupList
>
Exports
Account
Resolver
Agent
Auth
Resolver
Chapter
Resolver
Composer
Cover
Art
Resolver
Group
Resolver
constructor
agent
options
get
Group
search
get
Group
search
Manga
Resolver
Mangadex
User
Resolver
Check
Token
Response
Create
Manga
Options
Get
Cover
Arts
Options
Get
Manga
Feed
Options
Search
Chapter
Options
Search
Group
Options
Search
Manga
Options
Search
Users
Options
Default
Options
Generated using
TypeDoc
If true, will additionally fetch data in relationships. (user)