Interface FilterResults<T>

A filtered result object.

interface FilterResults<T> {
    results: T[];
    returnedResultCount: number;
    startingOffset: number;
    totalResults?: number;
}

Type Parameters

T

Index

Properties

results returnedResultCount startingOffset totalResults?

Properties

results

results: T[]

The result data.

returnedResultCount

returnedResultCount: number

The number of results returned in results.

startingOffset

startingOffset: number

The starting offset within the total available results.

`Optional`totalResults

totalResults?: number

The total available result count.