PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / breadcrumbGetters

Variable: breadcrumbGetters ​

const breadcrumbGetters: object

Defined in: getters/breadcrumbGetters.ts:35

Type Declaration ​

getCurrent ​

getCurrent: (breadcrumbs) => CategoryBreadcrumb | null

Parameters ​

CategoryBreadcrumb[]

Returns ​

CategoryBreadcrumb | null

getItemCount ​

getItemCount: (breadcrumb) => number

Parameters ​

CategoryBreadcrumb

Returns ​

number

getName ​

getName: (breadcrumb) => string

Parameters ​

CategoryBreadcrumb

Returns ​

string

getParent ​

getParent: (breadcrumbs) => CategoryBreadcrumb | null

Parameters ​

CategoryBreadcrumb[]

Returns ​

CategoryBreadcrumb | null

getUrl ​

getUrl: (breadcrumb) => string

Parameters ​

CategoryBreadcrumb

Returns ​

string

mapFromCategoryBreadcrumbs ​

mapFromCategoryBreadcrumbs: (categoryBreadcrumbs) => Breadcrumb[]

Maps an array of category breadcrumbs to the agnostic Breadcrumb format.

Parameters ​

categoryBreadcrumbs ​

CategoryBreadcrumb[]

The array of category breadcrumb objects from the API response.

Returns ​

Breadcrumb[]

An array of Breadcrumb objects with name and link properties.