Class AniLink

AniLink is a class for interacting with the APIs. It provides methods for querying and mutating data.

Index

Constructors

constructor

Properties

anilist

Constructors

constructor

new AniLink(authToken?: string, options?: AniLinkOptions): AniLink
Creates a new AniLink instance. The authToken parameter is optional and only required for authenticated queries and mutations. If no authToken is provided, only public queries will be available. You are able to create multiple AniLink instances with different authTokens.
Parameters
- OptionalauthToken: string
  The authentication token to use for API requests.
- Optionaloptions: AniLinkOptions
  Timeout, cancellation, and debugging settings for API requests.
Returns AniLink
Example
```
const aniLink = new AniLink('authToken');

const aniLink2 = new AniLink();
```
- Defined in AniLink.ts:1411

Properties

anilist

anilist: {
    custom: (query: string, variables: any) => Promise<any>;
    mutation: {
        deleteActivity: (variables: DeleteActivityVariables) => Promise<any>;
        deleteActivityReply: (
            variables: DeleteActivityReplyVariables,
        ) => Promise<any>;
        deleteCustomList: (variables: DeleteCustomListVariables) => Promise<any>;
        deleteMediaListEntry: (
            variables: DeleteMediaListEntryVariables,
        ) => Promise<DeleteMediaListEntryResponse>;
        deleteReview: (variables: DeleteReviewVariables) => Promise<any>;
        deleteThread: (variables: DeleteThreadVariables) => Promise<any>;
        deleteThreadComment: (
            variables: DeleteThreadCommentVariables,
        ) => Promise<any>;
        rateReview: (variables: RateReviewVariables) => Promise<ReviewResponse>;
        saveActivityReply: (
            variables: SaveActivityReplyVariables,
        ) => Promise<ActivityReply>;
        saveListActivity: (
            variables: SaveListActivityVariables,
        ) => Promise<Activity>;
        saveMediaListEntry: (
            variables: SaveMediaListEntryVariables,
        ) => Promise<MediaListResponse>;
        saveMessageActivity: (
            variables: SaveMessageActivityVariables,
        ) => Promise<Activity>;
        saveRecommendation: (
            variables: SaveRecommendationVariables,
        ) => Promise<RecommendationResponse>;
        saveReview: (variables: SaveReviewVariables) => Promise<ReviewResponse>;
        saveTextActivity: (
            variables: SaveTextActivityVariables,
        ) => Promise<Activity>;
        saveThread: (variables: SaveThreadVariables) => Promise<ThreadResponse>;
        saveThreadComment: (
            variables: SaveThreadCommentVariables,
        ) => Promise<ThreadCommentResponse>;
        toggleActivityPin: (
            variables: ToggleActivityPinVariables,
        ) => Promise<Activity>;
        toggleActivitySubscription: (
            variables: ToggleActivitySubscriptionVariables,
        ) => Promise<Activity>;
        toggleFavourite: (
            variables: ToggleFavouriteVariables,
        ) => Promise<Favourites>;
        toggleFollow: (variables: ToggleFollowVariables) => Promise<UserResponse>;
        toggleLike: (variables: ToggleLikeVariables) => Promise<any>;
        toggleLikeV2: (variables: ToggleLikeVariables) => Promise<Activity>;
        toggleThreadSubscription: (
            variables: ToggleThreadSubscriptionVariables,
        ) => Promise<ThreadResponse>;
        updateAniChartHighlights: (
            variables: UpdateAniChartHighlightsVariables,
        ) => Promise<any>;
        updateAniChartSettings: (
            variables: UpdateAniChartSettingsVariables,
        ) => Promise<any>;
        updateFavouriteOrder: (
            variables: UpdateFavouriteOrderVariables,
        ) => Promise<Favourites>;
        updateMediaListEntries: (
            variables: UpdateMediaListEntriesVariables,
        ) => Promise<MediaListResponse[]>;
        updateUser: (
            variables: UpdateUserVariables,
        ) => Promise<UpdateUserResponse>;
    };
    query: {
        activity: (variables: ActivityVariables) => Promise<Activity>;
        activityReply: (
            variables: ActivityReplyVariables,
        ) => Promise<ActivityReply>;
        airingSchedule: (
            variables: AiringScheduleVariables,
        ) => Promise<AiringScheduleResponse>;
        aniChartUser: () => Promise<AniChartUserResponse>;
        character: (variables: CharacterVariables) => Promise<CharacterResponse>;
        externalLinkSourceCollection: () => Promise<
            ExternalLinkSourceCollectionResponse,
        >;
        follower: (variables: FollowerVariables) => Promise<UserResponse>;
        following: (variables: FollowingVariables) => Promise<UserResponse>;
        genreCollection: () => Promise<string>;
        like: (variables: LikeVariables) => Promise<BasicUser>;
        markdown: (variables: MarkdownVariables) => Promise<string>;
        media: (variables: MediaVariables) => Promise<MediaResponse>;
        mediaList: (variables: MediaListVariables) => Promise<MediaListResponse>;
        mediaListCollection: (
            variables: MediaListCollectionVariables,
        ) => Promise<MediaListCollectionResponse>;
        mediaTagCollection: () => Promise<MediaTagCollectionResponse>;
        mediaTrend: (
            variables: MediaTrendVariables,
        ) => Promise<MediaTrendResponse>;
        notification: (
            variables: NotificationVariables,
        ) => Promise<NotificationResponse>;
        page: {
            activities: (variables: ActivitiesVariables) => Promise<Activity>;
            activityReplies: (
                variables: ActivityRepliesVariables,
            ) => Promise<ActivityReply>;
            airingSchedules: (
                variables: AiringSchedulesVariables,
            ) => Promise<AiringSchedulesPageResponse>;
            characters: (
                variables: CharactersVariables,
            ) => Promise<CharactersPageResponse>;
            followers: (
                variables: FollowersVariables,
            ) => Promise<FollowersPageResponse>;
            following: (
                variables: FollowingsVariables,
            ) => Promise<FollowingsPageResponse>;
            likes: (variables: LikesVariables) => Promise<BasicUser>;
            mediaLists: (
                variables: MediaListsVariables,
            ) => Promise<MediaListsPageResponse>;
            medias: (variables: MediasVariables) => Promise<MediasPageResponse>;
            mediaTrends: (
                variables: MediaTrendsVariables,
            ) => Promise<MediaTrendsPageResponse>;
            notifications: (
                variables: NotificationsVariables,
            ) => Promise<NotificationsPageResponse>;
            recommendations: (
                variables: RecommendationsVariables,
            ) => Promise<RecommendationsPageResponse>;
            reviews: (variables: ReviewsVariables) => Promise<ReviewsPageResponse>;
            staffs: (variables: StaffsVariables) => Promise<StaffsPageResponse>;
            studios: (variables: StudiosVariables) => Promise<StudiosPageResponse>;
            threadComments: (
                variables: ThreadCommentsVariables,
            ) => Promise<ThreadCommentsPageResponse>;
            threads: (variables: ThreadsVariables) => Promise<ThreadsPageResponse>;
            users: (variables: UsersVariables) => Promise<UsersPageResponse>;
        };
        recommendation: (
            variables: RecommendationVariables,
        ) => Promise<RecommendationResponse>;
        review: (variables: ReviewVariables) => Promise<ReviewResponse>;
        siteStatistics: () => Promise<SiteStatisticsResponse>;
        staff: (variables: StaffVariables) => Promise<StaffResponse>;
        studio: (variables: StudioVariables) => Promise<StudioResponse>;
        thread: (variables: ThreadVariables) => Promise<ThreadResponse>;
        threadComment: (
            variables: ThreadCommentVariables,
        ) => Promise<ThreadCommentResponse>;
        user: (variables: UserVariables) => Promise<UserResponse>;
        viewer: (variables: UserVariables) => Promise<UserResponse>;
    };
}

Anilist API methods.

Type Declaration

custom: (query: string, variables: any) => Promise<any>

Custom query or mutation.

Example

const viewer = await aniLink.anilist.custom('query {Viewer {id}}');

const mutation = 'mutation ($about: String) {UpdateUser (about: $about) {id}}';
const variables = { about: "New about text" };
const response = await aniLink.anilist.custom(mutation, variables);

mutation: {
    deleteActivity: (variables: DeleteActivityVariables) => Promise<any>;
    deleteActivityReply: (
        variables: DeleteActivityReplyVariables,
    ) => Promise<any>;
    deleteCustomList: (variables: DeleteCustomListVariables) => Promise<any>;
    deleteMediaListEntry: (
        variables: DeleteMediaListEntryVariables,
    ) => Promise<DeleteMediaListEntryResponse>;
    deleteReview: (variables: DeleteReviewVariables) => Promise<any>;
    deleteThread: (variables: DeleteThreadVariables) => Promise<any>;
    deleteThreadComment: (
        variables: DeleteThreadCommentVariables,
    ) => Promise<any>;
    rateReview: (variables: RateReviewVariables) => Promise<ReviewResponse>;
    saveActivityReply: (
        variables: SaveActivityReplyVariables,
    ) => Promise<ActivityReply>;
    saveListActivity: (
        variables: SaveListActivityVariables,
    ) => Promise<Activity>;
    saveMediaListEntry: (
        variables: SaveMediaListEntryVariables,
    ) => Promise<MediaListResponse>;
    saveMessageActivity: (
        variables: SaveMessageActivityVariables,
    ) => Promise<Activity>;
    saveRecommendation: (
        variables: SaveRecommendationVariables,
    ) => Promise<RecommendationResponse>;
    saveReview: (variables: SaveReviewVariables) => Promise<ReviewResponse>;
    saveTextActivity: (
        variables: SaveTextActivityVariables,
    ) => Promise<Activity>;
    saveThread: (variables: SaveThreadVariables) => Promise<ThreadResponse>;
    saveThreadComment: (
        variables: SaveThreadCommentVariables,
    ) => Promise<ThreadCommentResponse>;
    toggleActivityPin: (
        variables: ToggleActivityPinVariables,
    ) => Promise<Activity>;
    toggleActivitySubscription: (
        variables: ToggleActivitySubscriptionVariables,
    ) => Promise<Activity>;
    toggleFavourite: (
        variables: ToggleFavouriteVariables,
    ) => Promise<Favourites>;
    toggleFollow: (variables: ToggleFollowVariables) => Promise<UserResponse>;
    toggleLike: (variables: ToggleLikeVariables) => Promise<any>;
    toggleLikeV2: (variables: ToggleLikeVariables) => Promise<Activity>;
    toggleThreadSubscription: (
        variables: ToggleThreadSubscriptionVariables,
    ) => Promise<ThreadResponse>;
    updateAniChartHighlights: (
        variables: UpdateAniChartHighlightsVariables,
    ) => Promise<any>;
    updateAniChartSettings: (
        variables: UpdateAniChartSettingsVariables,
    ) => Promise<any>;
    updateFavouriteOrder: (
        variables: UpdateFavouriteOrderVariables,
    ) => Promise<Favourites>;
    updateMediaListEntries: (
        variables: UpdateMediaListEntriesVariables,
    ) => Promise<MediaListResponse[]>;
    updateUser: (variables: UpdateUserVariables) => Promise<UpdateUserResponse>;
}

Mutation methods for updating data on the Anilist API.
- deleteActivity: (variables: DeleteActivityVariables) => Promise<any>
  
  Deletes an activity on the Anilist API. Mod Only
  Example
```
await aniLink.anilist.mutation.deleteActivity({id: 1});
```
  See
  https://docs.anilist.co/reference/mutation
- deleteActivityReply: (variables: DeleteActivityReplyVariables) => Promise<any>
  
  Deletes an activity reply on the Anilist API.
  Example
```
await aniLink.anilist.mutation.deleteActivityReply({id: 1});
```
  See
  https://docs.anilist.co/reference/mutation
- deleteCustomList: (variables: DeleteCustomListVariables) => Promise<any>
  
  Deletes a custom list on the Anilist API. There is no mutation specifically for creating a custom list. You can create a custom list through the updateUser mutation under the animeListOptions or mangaListOptions variables.
  Example
```
await aniLink.anilist.mutation.deleteCustomLists({customList: 'test'});
```
  See
  https://docs.anilist.co/reference/mutation
- deleteMediaListEntry: (
  variables: DeleteMediaListEntryVariables,
  ) => Promise<DeleteMediaListEntryResponse>
  
  Deletes a media list entry on the Anilist API.
  Example
  You cannot delete a media list entry without first fetching the entry's id. The entry's id is not the same as the mediaId. It is specific to each user and media.
```
await aniLink.anilist.mutation.deleteMediaListEntry({id: 1});
```
  See
  https://docs.anilist.co/reference/mutation
- deleteReview: (variables: DeleteReviewVariables) => Promise<any>
  
  Deletes a review on the Anilist API.
  Example
```
await aniLink.anilist.mutation.deleteReview({id: 1});
```
  See
  https://docs.anilist.co/reference/mutation
- deleteThread: (variables: DeleteThreadVariables) => Promise<any>
  
  Deletes a thread on the Anilist API.
  Example
```
await aniLink.anilist.mutation.deleteThread({id: 1});
```
  See
  https://docs.anilist.co/reference/mutation
- deleteThreadComment: (variables: DeleteThreadCommentVariables) => Promise<any>
  
  Deletes a thread comment on the Anilist API.
  Example
```
await aniLink.anilist.mutation.deleteThreadComment({id: 1});
```
  See
  https://docs.anilist.co/reference/mutation
- rateReview: (variables: RateReviewVariables) => Promise<ReviewResponse>
  
  Rates a review on the Anilist API.
  Example
```
await aniLink.anilist.mutation.rateReview({reviewId: 8008, rating: 'UP_VOTE'});
```
  See
  https://docs.anilist.co/reference/mutation
- saveActivityReply: (variables: SaveActivityReplyVariables) => Promise<ActivityReply>
  
  Saves an activity reply on the Anilist API. If no id is provided, a new activity reply will be created. If an id is provided, the activity reply with that id will be updated.
  Example
```
await aniLink.anilist.mutation.saveActivityReply({activityId: 1, text: 'Hello, world!'});
```
  See
  https://docs.anilist.co/reference/mutation
- saveListActivity: (variables: SaveListActivityVariables) => Promise<Activity>
  
  Saves a list activity on the Anilist API. Mod Only
  Example
```
await aniLink.anilist.mutation.saveListActivity({id: 1});
```
  See
  https://docs.anilist.co/reference/mutation
- saveMediaListEntry: (variables: SaveMediaListEntryVariables) => Promise<MediaListResponse>
  
  Saves a media list entry on the Anilist API.
  Example
```
await aniLink.anilist.mutation.saveMediaListEntry({mediaId: 1, status: 'COMPLETED'});
```
  See
  https://docs.anilist.co/reference/mutation
- saveMessageActivity: (variables: SaveMessageActivityVariables) => Promise<Activity>
  
  Saves a message activity on the Anilist API. If no id is provided, a new activity will be created. If an id is provided, the activity with that id will be updated.
  Example
```
await aniLink.anilist.mutation.saveMessageActivity({text: 'Hello, world!'});
```
  See
  https://docs.anilist.co/reference/mutation
- saveRecommendation: (variables: SaveRecommendationVariables) => Promise<RecommendationResponse>
  
  Saves a recommendation on the Anilist API.
  Example
```
await aniLink.anilist.mutation.saveRecommendation({mediaId: 1, mediaRecommendationId: 2, rating: 8});
```
  See
  https://docs.anilist.co/reference/mutation
- saveReview: (variables: SaveReviewVariables) => Promise<ReviewResponse>
  
  Saves a review on the Anilist API. If no id is provided, a new review will be created. If an id is provided, the review with that id will be updated.
  Example
```
await aniLink.anilist.mutation.saveReview({mediaId: 1, body: 'testing', summary: 'testing', score: 8, private: true});
```
  See
  https://docs.anilist.co/reference/mutation
- saveTextActivity: (variables: SaveTextActivityVariables) => Promise<Activity>
  
  Saves a text activity on the Anilist API. If no id is provided, a new activity will be created. If an id is provided, the activity with that id will be updated.
  Example
```
await aniLink.anilist.mutation.saveTextActivity({text: 'Hello, world!'});
```
  See
  https://docs.anilist.co/reference/mutation
- saveThread: (variables: SaveThreadVariables) => Promise<ThreadResponse>
  
  Saves a thread on the Anilist API. If no id is provided, a new thread will be created. If an id is provided, the thread with that id will be updated.
  Example
```
await aniLink.anilist.mutation.saveThread({title: 'Hello, world!', body: 'Hello, world!'});
```
  See
  https://docs.anilist.co/reference/mutation
- saveThreadComment: (variables: SaveThreadCommentVariables) => Promise<ThreadCommentResponse>
  
  Saves a thread comment on the Anilist API. If no id is provided, a new thread comment will be created. If an id is provided, the thread comment with that id will be updated.
  Example
```
await aniLink.anilist.mutation.saveThreadComment({threadId: 1, comment: 'Hello, world!'});
```
  See
  https://docs.anilist.co/reference/mutation
- toggleActivityPin: (variables: ToggleActivityPinVariables) => Promise<Activity>
  
  Toggles the pin status of an activity on the Anilist API.
  Example
```
await aniLink.anilist.mutation.toggleActivityPin({id: 1, pinned: true});
```
  See
  https://docs.anilist.co/reference/mutation
- toggleActivitySubscription: (variables: ToggleActivitySubscriptionVariables) => Promise<Activity>
  
  Toggles the subscription status of an activity on the Anilist API.
  Example
```
await aniLink.anilist.mutation.toggleActivitySubscription({activityId: 1, subscribe: true});
```
  See
  https://docs.anilist.co/reference/mutation
- toggleFavourite: (variables: ToggleFavouriteVariables) => Promise<Favourites>
  
  Toggles a favorite on the Anilist API.
  Example
```
await aniLink.anilist.mutation.toggleFavorite({studioId: 561});
```
  See
  https://docs.anilist.co/reference/mutation
- toggleFollow: (variables: ToggleFollowVariables) => Promise<UserResponse>
  
  Toggles a follow on the Anilist API.
  Example
```
await aniLink.anilist.mutation.toggleFollow({userId: 542244});
```
  See
  https://docs.anilist.co/reference/mutation
- toggleLike: (variables: ToggleLikeVariables) => Promise<any>
  
  Toggles a like on the Anilist API.
  Example
```
await aniLink.anilist.mutation.toggleLike({id: 1, type: 'ACTIVITY'});
```
  See
  https://docs.anilist.co/reference/mutation
- toggleLikeV2: (variables: ToggleLikeVariables) => Promise<Activity>
  
  Toggles a like on the Anilist API. Returns a different response than the toggleLike mutation.
  Example
```
await aniLink.anilist.mutation.toggleLikeV2({id: 1, type: 'ACTIVITY'});
```
  See
  https://docs.anilist.co/reference/mutation
- toggleThreadSubscription: (variables: ToggleThreadSubscriptionVariables) => Promise<ThreadResponse>
  
  Toggles a thread subscription on the Anilist API.
  Example
```
await aniLink.anilist.mutation.toggleThreadSubscription({threadId: 1, subscribe: true});
```
  See
  https://docs.anilist.co/reference/mutation
- updateAniChartHighlights: (variables: UpdateAniChartHighlightsVariables) => Promise<any>
  
  Updates the AniChart highlights for a user on the Anilist API.
  Example
```
await aniLink.anilist.mutation.updateAniChartHighlights({highlights: [{mediaId: 1, highlight: 'test'}]});
```
  See
  https://docs.anilist.co/reference/mutation
- updateAniChartSettings: (variables: UpdateAniChartSettingsVariables) => Promise<any>
  
  Updates the AniChart settings for a user on the Anilist API.
  Example
```
await aniLink.anilist.mutation.updateAniChartSettings({titleLanguage: 'romaji', theme: 'dark'});
```
  See
  https://docs.anilist.co/reference/mutation
- updateFavouriteOrder: (variables: UpdateFavouriteOrderVariables) => Promise<Favourites>
  
  Updates the order of favourites on the Anilist API.
  Example
```
await aniLink.anilist.mutation.updateFavouriteOrder({ids: [1, 2, 3]});
```
  See
  https://docs.anilist.co/reference/mutation
- updateMediaListEntries: (variables: UpdateMediaListEntriesVariables) => Promise<MediaListResponse[]>
  
  Updates media list entries on the Anilist API.
  Example
```
await aniLink.anilist.mutation.updateMediaListEntries({
  status: 'CURRENT',
  score: 8.5,
  progress: 3,
  ids: [143271, 156822, 170890],
});
```
  See
  https://docs.anilist.co/reference/mutation
- updateUser: (variables: UpdateUserVariables) => Promise<UpdateUserResponse>
  
  Updates a user on the Anilist API.
  Example
```
await aniLink.anilist.mutation.updateUser({
  about: 'New about text',
  titleLanguage: 'ENGLISH',
  displayAdultContent: true,
  airingNotifications: true,
  scoreFormat: 'POINT_10',
  rowOrder: 'title',
  profileColor: 'blue',
  donatorBadge: 'Supporter',
  notificationOptions: [{type: 'AIRING', enabled: true}],
  timezone: '-06:00',
  activityMergeTime: 30,
  animeListOptions: {sectionOrder: ['title'], customLists: ['test'], advancedScoring: [], advancedScoringEnabled: false},
  mangaListOptions: {sectionOrder: ['title'], customLists: ['test'], advancedScoring: [], advancedScoringEnabled: false},
  staffNameLanguage: 'ROMAJI',
  restrictMessagesToFollowing: false,
  disabledListActivity: [{type: 'CURRENT', disabled: false}]
});
```
  See
  https://docs.anilist.co/reference/mutation
query: {
    activity: (variables: ActivityVariables) => Promise<Activity>;
    activityReply: (
        variables: ActivityReplyVariables,
    ) => Promise<ActivityReply>;
    airingSchedule: (
        variables: AiringScheduleVariables,
    ) => Promise<AiringScheduleResponse>;
    aniChartUser: () => Promise<AniChartUserResponse>;
    character: (variables: CharacterVariables) => Promise<CharacterResponse>;
    externalLinkSourceCollection: () => Promise<
        ExternalLinkSourceCollectionResponse,
    >;
    follower: (variables: FollowerVariables) => Promise<UserResponse>;
    following: (variables: FollowingVariables) => Promise<UserResponse>;
    genreCollection: () => Promise<string>;
    like: (variables: LikeVariables) => Promise<BasicUser>;
    markdown: (variables: MarkdownVariables) => Promise<string>;
    media: (variables: MediaVariables) => Promise<MediaResponse>;
    mediaList: (variables: MediaListVariables) => Promise<MediaListResponse>;
    mediaListCollection: (
        variables: MediaListCollectionVariables,
    ) => Promise<MediaListCollectionResponse>;
    mediaTagCollection: () => Promise<MediaTagCollectionResponse>;
    mediaTrend: (variables: MediaTrendVariables) => Promise<MediaTrendResponse>;
    notification: (
        variables: NotificationVariables,
    ) => Promise<NotificationResponse>;
    page: {
        activities: (variables: ActivitiesVariables) => Promise<Activity>;
        activityReplies: (
            variables: ActivityRepliesVariables,
        ) => Promise<ActivityReply>;
        airingSchedules: (
            variables: AiringSchedulesVariables,
        ) => Promise<AiringSchedulesPageResponse>;
        characters: (
            variables: CharactersVariables,
        ) => Promise<CharactersPageResponse>;
        followers: (
            variables: FollowersVariables,
        ) => Promise<FollowersPageResponse>;
        following: (
            variables: FollowingsVariables,
        ) => Promise<FollowingsPageResponse>;
        likes: (variables: LikesVariables) => Promise<BasicUser>;
        mediaLists: (
            variables: MediaListsVariables,
        ) => Promise<MediaListsPageResponse>;
        medias: (variables: MediasVariables) => Promise<MediasPageResponse>;
        mediaTrends: (
            variables: MediaTrendsVariables,
        ) => Promise<MediaTrendsPageResponse>;
        notifications: (
            variables: NotificationsVariables,
        ) => Promise<NotificationsPageResponse>;
        recommendations: (
            variables: RecommendationsVariables,
        ) => Promise<RecommendationsPageResponse>;
        reviews: (variables: ReviewsVariables) => Promise<ReviewsPageResponse>;
        staffs: (variables: StaffsVariables) => Promise<StaffsPageResponse>;
        studios: (variables: StudiosVariables) => Promise<StudiosPageResponse>;
        threadComments: (
            variables: ThreadCommentsVariables,
        ) => Promise<ThreadCommentsPageResponse>;
        threads: (variables: ThreadsVariables) => Promise<ThreadsPageResponse>;
        users: (variables: UsersVariables) => Promise<UsersPageResponse>;
    };
    recommendation: (
        variables: RecommendationVariables,
    ) => Promise<RecommendationResponse>;
    review: (variables: ReviewVariables) => Promise<ReviewResponse>;
    siteStatistics: () => Promise<SiteStatisticsResponse>;
    staff: (variables: StaffVariables) => Promise<StaffResponse>;
    studio: (variables: StudioVariables) => Promise<StudioResponse>;
    thread: (variables: ThreadVariables) => Promise<ThreadResponse>;
    threadComment: (
        variables: ThreadCommentVariables,
    ) => Promise<ThreadCommentResponse>;
    user: (variables: UserVariables) => Promise<UserResponse>;
    viewer: (variables: UserVariables) => Promise<UserResponse>;
}

Query methods for fetching data from the Anilist API.
- activity: (variables: ActivityVariables) => Promise<Activity>
  
  Fetches activity data from the Anilist API.
  Example
```
await aniLink.anilist.query.activity({id: 723235883, asHtml: true});
```
  See
  https://docs.anilist.co/reference/query
- activityReply: (variables: ActivityReplyVariables) => Promise<ActivityReply>
  
  Fetches activity reply data from the Anilist API.
  Example
```
await aniLink.anilist.query.activityReply({id: 12191046, asHtml: true});
```
  See
  https://docs.anilist.co/reference/query
- airingSchedule: (variables: AiringScheduleVariables) => Promise<AiringScheduleResponse>
  
  Fetches airing schedule data from the Anilist API.
  Example
```
await aniLink.anilist.query.airingSchedule({mediaId: 130590});
```
  Must be quering an airing anime. Returns error if not.
  See
  https://docs.anilist.co/reference/query
- aniChartUser: () => Promise<AniChartUserResponse>
  
  Fetches aniChart user data from the Anilist API.
  Example
```
await aniLink.anilist.query.aniChartUser();
```
  Must be authenticated.
  See
  https://docs.anilist.co/reference/query
- character: (variables: CharacterVariables) => Promise<CharacterResponse>
  
  Fetches character data from the Anilist API.
  Example
```
await aniLink.anilist.query.character({
  id: 1,
  asHtml: true,
  mediaSort: ['POPULARITY_DESC'],
  mediaType: 'ANIME',
  mediaOnList: true,
  mediaPage: 1,
  mediaPerPage: 10
});
```
  See
  https://docs.anilist.co/reference/query
- externalLinkSourceCollection: () => Promise<ExternalLinkSourceCollectionResponse>
  
  Fetches external link source collection data from the Anilist API.
  Example
```
await aniLink.anilist.query.externalLinkSourceCollection();
```
  See
  https://docs.anilist.co/reference/query
- follower: (variables: FollowerVariables) => Promise<UserResponse>
  
  Fetches follower data from the Anilist API.
  Example
```
await aniLink.anilist.query.follower({userId: 542244});
```
  See
  https://docs.anilist.co/reference/query
- following: (variables: FollowingVariables) => Promise<UserResponse>
  
  Fetches following data from the Anilist API.
  Example
```
await aniLink.anilist.query.following({userId: 542244});
```
  See
  https://docs.anilist.co/reference/query
- genreCollection: () => Promise<string>
  
  Fetches genre collection data from the Anilist API.
  Example
```
await aniLink.anilist.query.genreCollection()
```
  See
  https://docs.anilist.co/reference/query
- like: (variables: LikeVariables) => Promise<BasicUser>
  
  Fetches users who liked a model from the Anilist API.
  Example
```
await aniLink.anilist.query.like({likeableId: 723235883, type: 'ACTIVITY'});
```
  See
  https://docs.anilist.co/reference/query
- markdown: (variables: MarkdownVariables) => Promise<string>
  
  Fetches markdown data from the Anilist API.
  Example
```
await aniLink.anilist.query.markdown({markdown: 'Hello, world!'});
```
  See
  https://docs.anilist.co/reference/query
- media: (variables: MediaVariables) => Promise<MediaResponse>
  
  Fetches media data from the Anilist API.
  Example
```
await aniLink.anilist.query.media({id: 1, type: 'ANIME'});
```
  See
  https://docs.anilist.co/reference/query
- mediaList: (variables: MediaListVariables) => Promise<MediaListResponse>
  
  Fetches media list data from the Anilist API.
  Example
```
await aniLink.anilist.query.mediaList({userId: 542244});
```
  See
  https://docs.anilist.co/reference/query
- mediaListCollection: (
  variables: MediaListCollectionVariables,
  ) => Promise<MediaListCollectionResponse>
  
  Fetches media list collection data from the Anilist API.
  Example
```
await aniLink.anilist.query.mediaListCollection({
  userId: 542244,
  type: 'ANIME',
  status: 'COMPLETED',
  chunk: 1,
  perChunk: 10000
});
```
  See
  https://docs.anilist.co/reference/query
- mediaTagCollection: () => Promise<MediaTagCollectionResponse>
  
  Fetches media tag collection data from the Anilist API.
  Example
```
await aniLink.anilist.query.mediaTagCollection()
```
  See
  https://docs.anilist.co/reference/query
- mediaTrend: (variables: MediaTrendVariables) => Promise<MediaTrendResponse>
  
  Fetches media trend data from the Anilist API.
  Example
```
await aniLink.anilist.query.mediaTrend({mediaId: 1, type: 'ANIME'});
```
  See
  https://docs.anilist.co/reference/query
- notification: (variables: NotificationVariables) => Promise<NotificationResponse>
  
  Fetches notification data from the Anilist API.
  Example
```
await aniLink.anilist.query.notification({asHtml: true});
```
  Must be authenticated.
  See
  https://docs.anilist.co/reference/query
- page: {
      activities: (variables: ActivitiesVariables) => Promise<Activity>;
      activityReplies: (
          variables: ActivityRepliesVariables,
      ) => Promise<ActivityReply>;
      airingSchedules: (
          variables: AiringSchedulesVariables,
      ) => Promise<AiringSchedulesPageResponse>;
      characters: (
          variables: CharactersVariables,
      ) => Promise<CharactersPageResponse>;
      followers: (
          variables: FollowersVariables,
      ) => Promise<FollowersPageResponse>;
      following: (
          variables: FollowingsVariables,
      ) => Promise<FollowingsPageResponse>;
      likes: (variables: LikesVariables) => Promise<BasicUser>;
      mediaLists: (
          variables: MediaListsVariables,
      ) => Promise<MediaListsPageResponse>;
      medias: (variables: MediasVariables) => Promise<MediasPageResponse>;
      mediaTrends: (
          variables: MediaTrendsVariables,
      ) => Promise<MediaTrendsPageResponse>;
      notifications: (
          variables: NotificationsVariables,
      ) => Promise<NotificationsPageResponse>;
      recommendations: (
          variables: RecommendationsVariables,
      ) => Promise<RecommendationsPageResponse>;
      reviews: (variables: ReviewsVariables) => Promise<ReviewsPageResponse>;
      staffs: (variables: StaffsVariables) => Promise<StaffsPageResponse>;
      studios: (variables: StudiosVariables) => Promise<StudiosPageResponse>;
      threadComments: (
          variables: ThreadCommentsVariables,
      ) => Promise<ThreadCommentsPageResponse>;
      threads: (variables: ThreadsVariables) => Promise<ThreadsPageResponse>;
      users: (variables: UsersVariables) => Promise<UsersPageResponse>;
  }
  
  Fetches pages of data from the Anilist API. All page queries have the same structure as original queries with the addition of page and perPage variables.
  - activities: (variables: ActivitiesVariables) => Promise<Activity>
    
    Fetches activities data from the Anilist API.
    Example
    await aniLink.anilist.query.page.activities({page: 1, perPage: 10, userId: 542244});
    See
    https://docs.anilist.co/reference/query
  - activityReplies: (variables: ActivityRepliesVariables) => Promise<ActivityReply>
    
    Fetches activity replies data from the Anilist API.
    Example
    await aniLink.anilist.query.page.activityReplies({page: 1, perPage: 10, activityId: 723235883});
    See
    https://docs.anilist.co/reference/query
  - airingSchedules: (variables: AiringSchedulesVariables) => Promise<AiringSchedulesPageResponse>
    
    Fetches airing schedules data from the Anilist API.
    Example
    await aniLink.anilist.query.page.airingSchedules({page: 1, perPage: 10});
    See
    https://docs.anilist.co/reference/query
  - characters: (variables: CharactersVariables) => Promise<CharactersPageResponse>
    
    Fetches characters data from the Anilist API.
    Example
    await aniLink.anilist.query.page.characters({page: 1, perPage: 10});
    See
    https://docs.anilist.co/reference/query
  - followers: (variables: FollowersVariables) => Promise<FollowersPageResponse>
    
    Fetches followers data from the Anilist API.
    Example
    await aniLink.anilist.query.page.followers({page: 1, perPage: 10, userId: 542244});
    See
    https://docs.anilist.co/reference/query
  - following: (variables: FollowingsVariables) => Promise<FollowingsPageResponse>
    
    Fetches following data from the Anilist API.
    Example
    await aniLink.anilist.query.page.following({page: 1, perPage: 10, userId: 542244});
    See
    https://docs.anilist.co/reference/query
  - likes: (variables: LikesVariables) => Promise<BasicUser>
    
    Fetches likes data from the Anilist API.
    Example
    await aniLink.anilist.query.page.likes({page: 1, perPage: 10, likeAbleId: 1}); @see https:
  - mediaLists: (variables: MediaListsVariables) => Promise<MediaListsPageResponse>
    
    Fetches media lists data from the Anilist API.
    Example
    await aniLink.anilist.query.page.mediaLists({page: 1, perPage: 10, userId: 542244});
    See
    https://docs.anilist.co/reference/query
  - medias: (variables: MediasVariables) => Promise<MediasPageResponse>
    
    Fetches medias data from the Anilist API.
    Example
    await aniLink.anilist.query.page.medias({page: 1, perPage: 10, type: 'ANIME'});
    See
    https://docs.anilist.co/reference/query
  - mediaTrends: (variables: MediaTrendsVariables) => Promise<MediaTrendsPageResponse>
    
    Fetches media trends data from the Anilist API.
    Example
    await aniLink.anilist.query.page.mediaTrends({page: 1, perPage: 10, type: 'ANIME'});
    
    Must be quering an airing anime. Returns error if not.
    See
    https://docs.anilist.co/reference/query
  - notifications: (variables: NotificationsVariables) => Promise<NotificationsPageResponse>
    
    Fetches notifications data from the Anilist API.
    Example
    await aniLink.anilist.query.page.notifications({page: 1, perPage: 10});
    See
    https://docs.anilist.co/reference/query
  - recommendations: (variables: RecommendationsVariables) => Promise<RecommendationsPageResponse>
    
    Fetches recommendations data from the Anilist API.
    Example
    await aniLink.anilist.query.page.recommendations({page: 1, perPage: 10, mediaId: 1});
    See
    https://docs.anilist.co/reference/query
  - reviews: (variables: ReviewsVariables) => Promise<ReviewsPageResponse>
    
    Fetches reviews data from the Anilist API.
    Example
    await aniLink.anilist.query.page.reviews({page: 1, perPage: 10, mediaId: 1});
    See
    https://docs.anilist.co/reference/query
  - staffs: (variables: StaffsVariables) => Promise<StaffsPageResponse>
    
    Fetches staffs data from the Anilist API.
    Example
    await aniLink.anilist.query.page.staffs({page: 1, perPage: 10});
    See
    https://docs.anilist.co/reference/query
  - studios: (variables: StudiosVariables) => Promise<StudiosPageResponse>
    
    Fetches studios data from the Anilist API.
    Example
    await aniLink.anilist.query.page.studios({page: 1, perPage: 10});
    See
    https://docs.anilist.co/reference/query
  - threadComments: (variables: ThreadCommentsVariables) => Promise<ThreadCommentsPageResponse>
    
    Fetches thread comments data from the Anilist API.
    Example
    await aniLink.anilist.query.page.threadComments({page: 1, perPage: 10, threadId: 71881});
    See
    https://docs.anilist.co/reference/query
  - threads: (variables: ThreadsVariables) => Promise<ThreadsPageResponse>
    
    Fetches threads data from the Anilist API.
    Example
    await aniLink.anilist.query.page.threads({page: 1, perPage: 10});
    See
    https://docs.anilist.co/reference/query
  - users: (variables: UsersVariables) => Promise<UsersPageResponse>
    
    Fetches users data from the Anilist API.
    Example
    await aniLink.anilist.query.page.users({page: 1, perPage: 10});
    See
    https://docs.anilist.co/reference/query
- recommendation: (variables: RecommendationVariables) => Promise<RecommendationResponse>
  
  Fetches recommendation data from the Anilist API.
  Example
```
await aniLink.anilist.query.recommendation({mediaId: 156822, asHtml: true});
```
  See
  https://docs.anilist.co/reference/query
- review: (variables: ReviewVariables) => Promise<ReviewResponse>
  
  Fetches review data from the Anilist API.
  Example
```
await aniLink.anilist.query.review({id: 8008, asHtml: true});
```
  See
  https://docs.anilist.co/reference/query
- siteStatistics: () => Promise<SiteStatisticsResponse>
  
  Fetches site statistics data from the Anilist API.
  Example
```
await aniLink.anilist.query.siteStatistics();
```
  See
  https://docs.anilist.co/reference/query
- staff: (variables: StaffVariables) => Promise<StaffResponse>
  
  Fetches staff data from the Anilist API.
  Example
```
await aniLink.anilist.query.staff({
  id: 132186,
  asHtml: true,
  staffMediaSort: ['POPULARITY_DESC'],
  staffMediaType: 'ANIME',
  staffMediaOnList: true,
  staffMediaPage: 1,
  staffMediaPerPage: 10,
  charactersSort: ['ID'],
  charactersPage: 1,
  charactersPerPage: 10,
  characterMediaSort: ['POPULARITY_DESC'],
  characterMediaOnList: true,
  characterMediaPage: 1,
  characterMediaPerPage: 10
});
```
  See
  https://docs.anilist.co/reference/query
- studio: (variables: StudioVariables) => Promise<StudioResponse>
  
  Fetches studio data from the Anilist API.
  Example
```
await aniLink.anilist.query.studio({id: 561, asHtml: true});
```
  See
  https://docs.anilist.co/reference/query
- thread: (variables: ThreadVariables) => Promise<ThreadResponse>
  
  Fetches thread data from the Anilist API.
  Example
```
await aniLink.anilist.query.thread({id: 71881, asHtml: true});
```
  See
  https://docs.anilist.co/reference/query
- threadComment: (variables: ThreadCommentVariables) => Promise<ThreadCommentResponse>
  
  Fetches thread comment data from the Anilist API.
  Example
```
await aniLink.anilist.query.threadComment({id: 2555166, asHtml: true});
```
  See
  https://docs.anilist.co/reference/query
- user: (variables: UserVariables) => Promise<UserResponse>
  
  Fetches user data from the Anilist API.
  Example
```
await aniLink.anilist.query.user({id: 542244, asHtml: true});
```
  See
  https://docs.anilist.co/reference/query
- viewer: (variables: UserVariables) => Promise<UserResponse>
  
  Fetches viewer data from the Anilist API.
  Example
```
await aniLink.anilist.query.viewer({asHtml: true});
```
  Must be authenticated.
  See
  https://docs.anilist.co/reference/query

Class AniLink

Index

Constructors

Properties

Constructors

constructor

Parameters

Returns AniLink

Example

Properties

anilist

Type Declaration

custom: (query: string, variables: any) => Promise<any>

Example

deleteActivity: (variables: DeleteActivityVariables) => Promise<any>

Example

See

deleteActivityReply: (variables: DeleteActivityReplyVariables) => Promise<any>

Example

See

deleteCustomList: (variables: DeleteCustomListVariables) => Promise<any>

Example

See

deleteMediaListEntry: ( variables: DeleteMediaListEntryVariables,) => Promise<DeleteMediaListEntryResponse>

Example

See

deleteReview: (variables: DeleteReviewVariables) => Promise<any>

Example

See

deleteThread: (variables: DeleteThreadVariables) => Promise<any>

Example

See

deleteThreadComment: (variables: DeleteThreadCommentVariables) => Promise<any>

Example

See

rateReview: (variables: RateReviewVariables) => Promise<ReviewResponse>

Example

See

saveActivityReply: (variables: SaveActivityReplyVariables) => Promise<ActivityReply>

Example

See

saveListActivity: (variables: SaveListActivityVariables) => Promise<Activity>

Example

See

saveMediaListEntry: (variables: SaveMediaListEntryVariables) => Promise<MediaListResponse>

Example

See

saveMessageActivity: (variables: SaveMessageActivityVariables) => Promise<Activity>

Example

See

saveRecommendation: (variables: SaveRecommendationVariables) => Promise<RecommendationResponse>

Example

See

saveReview: (variables: SaveReviewVariables) => Promise<ReviewResponse>

Example

See

saveTextActivity: (variables: SaveTextActivityVariables) => Promise<Activity>

Example

See

saveThread: (variables: SaveThreadVariables) => Promise<ThreadResponse>

Example

See

saveThreadComment: (variables: SaveThreadCommentVariables) => Promise<ThreadCommentResponse>

Example

See

toggleActivityPin: (variables: ToggleActivityPinVariables) => Promise<Activity>

Example

See

toggleActivitySubscription: (variables: ToggleActivitySubscriptionVariables) => Promise<Activity>

Example

See

toggleFavourite: (variables: ToggleFavouriteVariables) => Promise<Favourites>

Example

See

toggleFollow: (variables: ToggleFollowVariables) => Promise<UserResponse>

Example

See

toggleLike: (variables: ToggleLikeVariables) => Promise<any>

Example

See

deleteMediaListEntry: (
variables: DeleteMediaListEntryVariables,
) => Promise<DeleteMediaListEntryResponse>

mediaListCollection: (
variables: MediaListCollectionVariables,
) => Promise<MediaListCollectionResponse>