PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / facetGetters

Variable: facetGetters ​

const facetGetters: object

Defined in: getters/facetGetters.ts:114

Type Declaration ​

getAll ​

getAll: (params, criteria?) => AgnosticFacet[]

Parameters ​

params ​

FacetSearchResult<Facet>

criteria? ​

FacetSearchCriteria

Returns ​

AgnosticFacet[]

getCategory ​

getCategory: (params) => Category

Parameters ​

params ​

FacetSearchResult<Facet>

Returns ​

Category

getCssClass ​

getCssClass: (filter) => string

Parameters ​

filter ​

Filter

Returns ​

string

getFilterCount ​

getFilterCount: (filter) => number

Parameters ​

filter ​

Filter

Returns ​

number

getFilterName ​

getFilterName: (filter) => string

Parameters ​

filter ​

Filter

Returns ​

string

getFilters ​

getFilters: (filterGroup) => Filter[]

Parameters ​

filterGroup ​

FilterGroup

Returns ​

Filter[]

getName ​

getName: (filterGroup) => string

Parameters ​

filterGroup ​

FilterGroup

Returns ​

string

getPagination ​

getPagination: (params) => AgnosticPagination

Parameters ​

params ​

FacetSearchResult<Facet>

Returns ​

AgnosticPagination

getProducts ​

getProducts: (searchData) => Product[]

Parameters ​

searchData ​

FacetSearchResult<Facet>

Returns ​

Product[]

getSortOptions ​

getSortOptions: (params) => AgnosticSort

Parameters ​

params ​

FacetSearchResult<Facet>

Returns ​

AgnosticSort

getType ​

getType: (filterGroup) => string

Parameters ​

filterGroup ​

FilterGroup

Returns ​

string

hasFilters ​

hasFilters: (filterGroup) => boolean

Parameters ​

filterGroup ​

FilterGroup[]

Returns ​

boolean