Class: VersionsHelper

VersionsHelper()

A helper type for resource version-related API endpoints.

Constructor

new VersionsHelper()

Source:

Methods

(async) delete(resourceId, versionId)

Delete a version for a given resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
versionId number The identifier of the version.
Source:

(async) fetch(resourceId, versionId) → {Version}

Fetch a version for a given resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
versionId number The identifier of the version.
Source:
Returns:
A raw data object.
Type
Version

(async) latest(resourceId) → {Version}

Fetch the latest version for a given resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
Source:
Returns:
A raw data object.
Type
Version

(async) list(resourceId, sort) → {Array.<Version>}

List a page of versions for a given resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<Version>

(async) listAll(resourceId, sort) → {Array.<Version>}

List all pages of versions for a given resource.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<Version>

(async) listUntil(resourceId, shouldContinue, sort) → {Array.<Version>}

List multiple pages of versions for a given resource until a condition is no longer met.
Parameters:
Name Type Description
resourceId number The identifier of the resource.
shouldContinue function A function which determines if further pages are requested.
sort SortOptions | undefined An optional set of sort options.
Source:
Returns:
An array of raw data objects.
Type
Array.<Version>