Get changelog build

The changelog.getChangelogBuild method on a Client instance makes a GET request to the changelog/{stream}/{build} endpoint and returns a changelog build.

Example

const build = await api.changelog.getChangelogBuild('lazer', '2023.305.0');

Parameters

Parameter	Type	Optional	Description
stream	ChangelogStream		Update stream name
build	string		Build version

Returns

Promise<
  Build & {
    changelog_entries: (ChangelogEntry & {
      github_user: GithubUser;
      message: string | null;
      message_html: string | null;
    })[];
    versions: BuildVersions;
  }
>;

Types

Build
ChangelogEntry
GithubUser
BuildVersions

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 .