Interface: FetchByOffsetResults

Oracle® JavaScript Extension Toolkit (JET)
7.1.0

F18183-01

Signature:

interface FetchByOffsetResults<K, D>

QuickNav

Fields


PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

FetchByOffsetResults

Version:
  • 7.1.0
Since:
  • 4.1.0
Module:
  • ojdataprovider

Module usage

See JET Module Loading for an overview of module usage within JET.

Typescript Import Format
//To use this interface, import as below.
import {FetchByOffsetResults} from "ojs/ojdataprovider";

JET In Typescript

A detailed description of working with JET elements and classes in your typescript project can be found at: JET Typescript Usage.

The interface for oj.FetchByOffsetResults

Fields

done :boolean

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Indicates whether there are more items which can be fetched.

If this is true, fetching the next block will likely return an empty array as the result. A DataProvider can potentially make a stronger guarantee (if the DataProvider is running against an immutable repository or the DataProvider doesn’t attempt to retrieve a subsequent block if the DataProvider believes it is complete). We don’t generally make the stronger guarantee since the repository may have been mutated since the previous response with done:true, such that new records would be returned.

If this is false, fetching the next block may or may not return an empty array as a result.

Since:
  • 4.1.0

fetchParameters :FetchByOffsetParameters<D>

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

The parameters used for the fetch call.
Since:
  • 4.1.0

results :Array<Item<K, D>>

PREVIEW: This is a preview API. Preview APIs are production quality, but can be changed on a major version without a deprecation path.

Array of oj.Item.
Since:
  • 4.1.0