v2.comments.list

Returns a list comments and their replies up to 2 levels deep

Authentication

const { auth } = require('osu-api-extended');

await auth.login(client_id, client_secret);

Function

await v2.comments.list(object)

Parameters

Parameter	Type	Description
object.commentable_type	string	news_post or beatmapset
object.commentable_id	string	id of the resource to get comments for
object.cursor	undefined	undefined
object.parent_id	string	id of the comment parent
object.sort	string	new or old or top

Response

export interface response {
  comments: {
    id: number;
    parent_id?: number;
    user_id: number;
    pinned: boolean;
    replies_count: number;
    votes_count: number;
    commentable_type: string;
    commentable_id: number;
    legacy_name?: string;
    created_at: string;
    updated_at: string;
    deleted_at?: string;
    edited_at?: string;
    edited_by_id?: string;
    message: string;
    message_html: string;
  }[];
  has_more: boolean;
  has_more_id: string;
  included_comments: {
    id: number;
    parent_id?: string;
    user_id: number;
    pinned: boolean;
    replies_count: number;
    votes_count: number;
    commentable_type: string;
    commentable_id: number;
    legacy_name?: string;
    created_at: string;
    updated_at: string;
    deleted_at?: string;
    edited_at?: string;
    edited_by_id?: string;
    message: string;
    message_html: string;
  }[];
  pinned_comments: [];
  user_votes: [];
  user_follow: boolean;
  users: {
    avatar_url: string;
    country_code: string;
    default_group: string;
    id: number;
    is_active: boolean;
    is_bot: boolean;
    is_deleted: boolean;
    is_online: boolean;
    is_supporter: boolean;
    last_visit?: string;
    pm_friends_only: boolean;
    profile_colour?: string;
    username: string;
  }[];
  sort: string;
  cursor: {
    created_at: string;
    id: number;
  };
  top_level_count: number;
  total: number;
  commentable_meta: {
    current_user_attributes: {
      can_new_comment_reason: string;
    };
    id?: number;
    type?: string;
    title: string;
    url?: string;
    owner_id?: number;
    owner_title?: string;
  }[];
}