Get changelog listing

The changelog.getChangelogListing method on a Client instance makes a GET request to the changelog endpoint and returns an object containing a array of builds, update stream and search parameters used.

Example

const listing = await api.changelog.getChangelogListing();

Parameters

Parameter	Type	Optional	Description
options	GetChangelogListingOptions	✓

options.query

Parameter	Type	Optional	Description
from	string	✓	Minimum build version
max_id	number	✓	Maximum build ID
stream	ChangelogStream	✓	Stream name to return builds from
to	string	✓	Maximum build version
message_formats	(‘html’ | ‘markdown’)[]	✓	Changelog entry format (returns both by default)

Returns

Promise<{
  builds: (Build & {
    changelog_entries: (ChangelogEntry & {
      github_user: GithubUser;
      message: string | null;
      message_html: string | null;
    })[];
  })[];
  search: {
    from: string | null;
    limit: 21;
    max_id: number | null;
    stream: string | null;
    to: string | null;
  };
  streams: (UpdateStream & {
    latest_build: Build;
    user_count: number;
  })[];
}>;

Types

• Build
• ChangelogEntry
• GithubUser
• UpdateStream

Possible Exceptions

See the error handling documentation for more information.

• invalid_json_syntax
• network_error
• unexpected_response

Notice that something is missing? Found a typo? Think something's incomplete? Or think that something can be explained better? Feel free to open a pull request or submit an issue on the library's Github repository .