Open Asterune
CatalogSearchParams

CatalogSearchParams

Configures catalog search filters, limits, and ordering.

Behavior

CatalogSearchParams configures catalog search filters, limits, and ordering.

Summary

Constructors1
Functions1
  • CatalogSearchParams.new(): CatalogSearchParams

    Creates catalog search options.

Members13
Properties12
Methods1
  • Clone(): CatalogSearchParams

    Returns an independent copy of the search options.

Constructors

new

CatalogSearchParams.new(): CatalogSearchParams

Creates catalog search options.

Properties

CategoryFilter

CatalogSearchParams.CategoryFilter: EnumItem

The catalog category included in the search.

CreatorId

CatalogSearchParams.CreatorId: number

The creator identifier used to filter results.

CreatorName

CatalogSearchParams.CreatorName: string

The creator name used to filter results.

CreatorType

CatalogSearchParams.CreatorType: EnumItem

Whether the creator filter refers to a user or a group.

IncludeOffSale

CatalogSearchParams.IncludeOffSale: boolean

Whether to include entries that are not currently for sale.

Limit

CatalogSearchParams.Limit: number

The maximum number of entries requested.

MaxPrice

CatalogSearchParams.MaxPrice: number

The highest included price.

MinPrice

CatalogSearchParams.MinPrice: number

The lowest included price.

SalesTypeFilter

CatalogSearchParams.SalesTypeFilter: EnumItem

The sales category included in the search.

SearchKeyword

CatalogSearchParams.SearchKeyword: string

The text used to search catalog entries.

SortAggregation

CatalogSearchParams.SortAggregation: EnumItem

The time window used when ranking results.

SortType

CatalogSearchParams.SortType: EnumItem

The ordering applied to search results.

Methods

Clone

CatalogSearchParams:Clone(): CatalogSearchParams

Returns an independent copy of the search options.

Operators

__tostring · __type