Interface Parameters

interface Parameters {
    cf?: Record<string, string[]>;
    df?: Record<string, DateRangeRequest[]>;
    dfExcluded?: Record<string, DateRangeRequest[]>;
    f?: Record<string, string[]>;
    fExcluded?: Record<string, string[]>;
    lf?: Record<string, string[]>;
    mnf?: Record<string, NumericRangeRequest[]>;
    mnfExcluded?: Record<string, NumericRangeRequest[]>;
    nf?: Record<string, NumericRangeRequest[]>;
    nfExcluded?: Record<string, NumericRangeRequest[]>;
    page?: number;
    perPage?: number;
    sortCriteria?: SortCriterion;
}

Hierarchy (View Summary)

Properties

cf? df? dfExcluded? f? fExcluded? lf? mnf? mnfExcluded? nf? nfExcluded? page? perPage? sortCriteria?

Properties

Optionalcf

cf?: Record<string, string[]>

A record of the category facets, where the key is the facet id, and the value is an array containing the parts of the selected path.

Optionaldf

df?: Record<string, DateRangeRequest[]>

A record of the date facets, where the key is the facet id, and the value is an array containing the selected date ranges.

OptionaldfExcluded

dfExcluded?: Record<string, DateRangeRequest[]>

A record of the date facets, where the key is the facet id, and the value is an array containing the excluded date ranges.

Optionalf

f?: Record<string, string[]>

A record of the facets, where the key is the facet id, and the value is an array containing the selected values.

OptionalfExcluded

fExcluded?: Record<string, string[]>

A record of the facets, where the key is the facet id, and the value is an array containing the excluded values.

Optionallf

lf?: Record<string, string[]>

A record of the location facets, where the key is the facet id, and the value is an array containing the selected values.

Optionalmnf

mnf?: Record<string, NumericRangeRequest[]>

A record of manual numeric facets, where the key is the facet id, and the the value is an array containing the selected manual numeric ranges.

OptionalmnfExcluded

mnfExcluded?: Record<string, NumericRangeRequest[]>

A record of manual numeric facets, where the key is the facet id, and the value is an array containing the excluded manual numeric ranges.

Optionalnf

nf?: Record<string, NumericRangeRequest[]>

A record of the numeric facets, where the key is the facet id, and the value is an array containing the selected numeric ranges.

OptionalnfExcluded

nfExcluded?: Record<string, NumericRangeRequest[]>

A record of the numeric facets, where the key is the facet id, and the value is an array containing the excluded numeric ranges.

Optionalpage

page?: number

The zero-based index of the active page.

OptionalperPage

perPage?: number

The number of results per page.

OptionalsortCriteria

sortCriteria?: SortCriterion

The sort expression to order returned results by.

Settings

Member Visibility

On This Page

Properties