Preparing search index...
The search index is not available
node-shikimori - v
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
node-shikimori
UsersByIdParams
Interface UsersByIdParams
Hierarchy
UsersByIdParams
Index
Properties
id
is_
nickname?
Properties
id
id
:
string
|
number
Optional
is_
nickname
is_
nickname
?:
boolean
On This Page
id
is_
nickname
node-
shikimori
APIError
Abuse
Request
Abuse
Requests
Abuse
Params
Abuse
Requests
Offtopic
Params
Abuse
Requests
Review
Params
Access
Token
Access Token which represents the access token received from an OAuth2 authentication request
Achievement
Achievements
Params
Anime
Anime
Basic
Anime
Relation
Animes
Params
Animes
Topics
Params
Appears
Params
Auth
Options
Represents a set of options required for authenticating a client
Ban
Calendar
Params
Character
Character
Basic
Characters
Params
Characters
Search
Params
Client
Options
Options for configuring a Shikimori wrapper
Club
Club
Basic
Club
Constants
Club
Update
Template
Clubs
Content
Params
Clubs
Params
Clubs
Update
Params
Comment
Comment
Basic
Comment
Template
Comments
Create
Params
Comments
Params
Comments
Update
Params
Content
Content
Constants
Content
Relation
Dialog
Episode
Episode
Notification
Episode
Notification
Template
Episode
Notifications
Params
External
Link
Favorites
Create
Params
Favorites
Destroy
Params
Favorites
Reorder
Params
Forum
Franchise
Franchise
Link
Franchise
Node
Genre
Ignore
Notice
Image
Image
Set
Linkable
Manga
Manga
Basic
Manga
Relation
Manga
Topics
Params
Mangas
Params
Message
Message
Basic
Notice
Notice
Success
People
Search
Params
Person
Person
Basic
Person
Role
Person
Vital
Day
Person
Work
Publisher
Ranobe
Ranobe
Basic
Ranobe
Params
Ranobe
Relation
Ranobe
Topics
Params
Rate
Score
Stat
Rate
Status
Stat
Review
Reviews
Create
Params
Reviews
Update
Params
Role
Role
Based
Screenshot
Smiley
Studio
Style
Styles
Create
Params
Styles
Preview
Params
Styles
Update
Params
Topic
Topic
Basic
Topic
Ignore
Topic
Ignore
Params
Topic
Template
Topic
Update
Template
Topics
Create
Params
Topics
Hot
Params
Topics
List
Params
Topics
Update
Params
Topics
Updates
Params
User
User
Activity
User
Basic
User
Favourite
User
Favourites
User
History
Record
User
Ignore
User
Ignore
Params
User
Image
User
Images
Create
Params
User
Rate
User
Rate
Basic
User
Rate
Constants
User
Rate
Create
Params
User
Rate
Extended
User
Rate
Template
User
Rate
Update
Params
User
Rates
List
Params
User
Stats
Status
User
Unread
Messages
Users
Anime
Rates
Params
Users
By
Id
Params
Users
History
Params
Users
List
Params
Users
Manga
Rates
Params
Users
Messages
Params
Video
Videos
Create
Params
Videos
Destroy
Params
Videos
List
Params
Achievement
Id
Anime
Duration
Anime
Id
Anime
Kind
Anime
Order
Anime
Rating
Anime
Status
Anime
Topic
Kind
Ban
Id
Character
Id
Club
Comment
Policy
Club
Id
Club
Image
Upload
Policy
Club
Join
Policy
Club
Topic
Policy
Comment
Id
Commentable
Type
Date
Time
Day
Dialog
Id
Favorites
Kind
Favorites
Linked
Type
Forum
Id
Franchise
Link
Id
Franchise
Node
Id
Franchise
Relation
Type
Genre
Entry
Type
Genre
Id
Id
Represents an interface with an 'id' property of type T
Image
Id
Linked
Id
Linked
Type
Manga
Id
Manga
Kind
Manga
Order
Manga
Status
Message
Id
Message
Kind
Message
Type
Person
Grouped
Role
Person
Id
Person
Kind
Publisher
Id
Ranobe
Id
Ranobe
Kind
Ranobe
Order
Ranobe
Status
Review
Id
Review
Opinion
Studio
Id
Style
Id
Token
Represents an OAuth2 access token, which is a string value that grants access to protected resources.
Topic
Event
Type
Topic
Forum
Topic
Id
Topic
Type
User
Content
Kind
User
History
Record
Id
User
Id
User
Image
Id
User
Rate
Id
User
Rate
Status
Video
Hosting
Video
Id
Video
Kind
BASE_
URL
The base URL for the Shikimori API
DEFAULT_
USER_
AGENT
The default user agent string used when making API requests
MAX_
CALLS_
PER_
MINUTE
The maximum number of API calls that can be made per minute
MAX_
CALLS_
PER_
SECOND
The maximum number of API calls that can be made per second
TOKEN_
PATH
The path to the OAuth2 token endpoint
abuse
Requests
Abuse Requests
achievements
Achievements
animes
Animes
appears
Appear
auth
OAuth2-based authorization layer
bans
Bans
calendars
Calendars
characters
Characters
client
A Shikimori API wrapper that provides methods for interacting with various endpoints
clubs
Clubs
comments
Comments
constants
Constants
dialogs
Dialogs
episode
Notifications
Episode notifications
favorites
Favorites
forums
Forums
friends
Friends
genres
Genres
mangas
Mangas
people
People
publishers
Publishers
ranobe
Ranobe
reviews
Reviews
stats
Stats
studios
Studios
styles
Styles
topic
Ignores
Topic ignores
topics
Topics
user
Ignores
User ignores
user
Images
User Images
user
Rates
User rates
users
Users
videos
Videos
Generated using
TypeDoc