Lookup changelog build

The changelog.lookupChangelogBuild method on a Client instance makes a GET request to the changelog/{changelog} endpoint and returns a changelog build if it exists, otherwise undefined.

Example

const build = await api.changelog.lookupChangelogBuild('2023.305.0');

Parameters

Parameter	Type	Optional	Description
changelog	string | number		Build version, update stream name, or build ID
options	LookupChangelogBuildOptions	✓

options.query

Parameter	Type	Optional	Description
key	‘id’	✓	Unset to query by build version or stream name, or id to query by build ID
message_formats	(‘html’ | ‘markdown’)[]	✓	Changelog entry format (returns both by default)

Returns

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

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 .