osu-api-v2-js
    Preparing search index...

    Interface WithChangelogentriesVersions

    API.getChangelogBuild / API.lookupChangelogBuild

    interface WithChangelogentriesVersions {
        changelog_entries: {
            category: string;
            created_at: Date | null;
            github_pull_request_id: number | null;
            github_url: string | null;
            github_user?: {
                display_name: string;
                github_url: string | null;
                github_username: string | null;
                id: number | null;
                osu_username: string | null;
                user_id: number | null;
                user_url: string | null;
            };
            id: number
            | null;
            major: boolean;
            message?: string | null;
            message_html?: string | null;
            repository: string | null;
            title: string | null;
            type: string;
            url: string | null;
        }[];
        created_at: Date;
        display_version: string;
        id: number;
        users: number;
        version: string
        | null;
        versions: {
            next: WithUpdatestreams | null;
            previous: WithUpdatestreams | null;
        };
        youtube_id: string
        | null;
    }

    Hierarchy

    • WithChangelogentries
      • WithChangelogentriesVersions
    Index

    Properties

    changelog_entries created_at display_version id users version versions youtube_id

    Properties

    changelog_entries: {
        category: string;
        created_at: Date | null;
        github_pull_request_id: number | null;
        github_url: string | null;
        github_user?: {
            display_name: string;
            github_url: string | null;
            github_username: string | null;
            id: number | null;
            osu_username: string | null;
            user_id: number | null;
            user_url: string | null;
        };
        id: number
        | null;
        major: boolean;
        message?: string | null;
        message_html?: string | null;
        repository: string | null;
        title: string | null;
        type: string;
        url: string | null;
    }[]

    Type Declaration

    • category: string
    • created_at: Date | null

      Can be January 1st 1970, and can be null if it's for example a notice to say the build is a hotfix

    • github_pull_request_id: number | null
    • github_url: string | null

      The URL of the Pull Request, for example https://github.com/ppy/osu/pull/<github_pull_request_id>

    • Optionalgithub_user?: {
          display_name: string;
          github_url: string | null;
          github_username: string | null;
          id: number | null;
          osu_username: string | null;
          user_id: number | null;
          user_url: string | null;
      }

      Doesn't exist if no github user is associated with the person who's credited with the change

      • display_name: string
      • github_url: string | null
      • github_username: string | null
      • id: number | null
      • osu_username: string | null
      • user_id: number | null
      • user_url: string | null

        The URL of the user's osu! profile, for example https://osu.ppy.sh/users/<user_id>

    • id: number | null
    • major: boolean
    • Optionalmessage?: string | null

      Entry message in Markdown format, embedded HTML is allowed

      Exists only if Markdown was requested, may still be null if there is no message

    • Optionalmessage_html?: string | null

      Entry message in HTML format

      Exists only if HTML was requested, may still be null if there is no message

    • repository: string | null
    • title: string | null
    • type: string
    • url: string | null
    created_at: Date
    display_version: string
    id: number
    users: number

    How many users are playing on this version of the game? (if web, should be 0)

    version: string | null

    The name of the version

    versions: { next: WithUpdatestreams | null; previous: WithUpdatestreams | null }
    youtube_id: string | null

    If a video is showcased on the changelog

    The ID of a Youtube video is whatever comes after /watch?v= in its url

    Settings

    Member Visibility

    On This Page

    Properties