PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / reviewGetters

Variable: reviewGetters ​

const reviewGetters: object

Defined in: getters/reviewGetters.ts:115

Type Declaration ​

getAverageRating() ​

getAverageRating: (counts, roundOption?) => number

Parameters ​

counts ​

ReviewCounts

roundOption? ​

"half" | "tenth"

Returns ​

number

getCurrentReviewsPage() ​

getCurrentReviewsPage: (review) => number

Parameters ​

review ​

Review

Returns ​

number

getRatesCount() ​

getRatesCount: (review) => AgnosticRateCount[]

Parameters ​

review ​

Review

Returns ​

AgnosticRateCount[]

getReplyAuthor() ​

getReplyAuthor: (replyItem) => string

Parameters ​

replyItem ​

ReviewItem

Returns ​

string

getReplyDate() ​

getReplyDate: (replyItem) => string

Parameters ​

replyItem ​

ReviewItem

Returns ​

string

getReplyMessage() ​

getReplyMessage: (replyItem) => string

Parameters ​

replyItem ​

ReviewItem

Returns ​

string

getReplyTargetId() ​

getReplyTargetId: (replyItem) => number

Parameters ​

replyItem ​

ReviewItem

Returns ​

number

getReviewAuthor() ​

getReviewAuthor: (item) => string

Parameters ​

item ​

ReviewItem

Returns ​

string

getReviewCounts() ​

getReviewCounts: (review) => ReviewCounts

Parameters ​

review ​

Review

Returns ​

ReviewCounts

getReviewCountsOrPercentagesByRatingDesc() ​

getReviewCountsOrPercentagesByRatingDesc: (reviewCounts, returnPercentage) => number[]

Parameters ​

reviewCounts ​

ReviewCounts

returnPercentage ​

boolean = false

Returns ​

number[]

getReviewDate() ​

getReviewDate: (item) => string

Parameters ​

item ​

ReviewItem

Returns ​

string

getReviewId() ​

getReviewId: (item) => string

Parameters ​

item ​

ReviewItem

Returns ​

string

getReviewItems() ​

getReviewItems: (review) => ReviewItem[]

Parameters ​

review ​

Review

Returns ​

ReviewItem[]

getReviewMessage() ​

getReviewMessage: (item) => string

Parameters ​

item ​

ReviewItem

Returns ​

string

getReviewPagination() ​

getReviewPagination: (review) => ReviewPagination

Parameters ​

review ​

Review

Returns ​

ReviewPagination

getReviewRating() ​

getReviewRating: (item) => number

Parameters ​

item ​

ReviewItem

Returns ​

number

getReviewReplies() ​

getReviewReplies: (item) => ReviewItem[]

Parameters ​

item ​

ReviewItem

Returns ​

ReviewItem[]

getReviewTitle() ​

getReviewTitle: (item) => string

Parameters ​

item ​

ReviewItem

Returns ​

string

getReviewVisibility() ​

getReviewVisibility: (item) => boolean

Parameters ​

item ​

ReviewItem

Returns ​

boolean

getTotalReviews() ​

getTotalReviews: (counts) => number

Parameters ​

counts ​

ReviewCounts

Returns ​

number

getVerifiedPurchase() ​

getVerifiedPurchase: (item) => boolean

Parameters ​

item ​

ReviewItem

Returns ​

boolean