Format points

JavaScript

Smile.formatPoints(1);
// Returns "1 Point"

Smile.formatPoints(
  2400,
  { showPointsLabel: false }
);
// Returns "2,400"

Smile.formatPoints(
  5000,
  { pointsLabelPrefix: 'Bonus ' }
);
// Returns "5,000 Bonus Points"

JavaScript

Smile.formatPoints(1);
// Returns "1 Point"

Smile.formatPoints(
  2400,
  { showPointsLabel: false }
);
// Returns "2,400"

Smile.formatPoints(
  5000,
  { pointsLabelPrefix: 'Bonus ' }
);
// Returns "5,000 Bonus Points"

This method formats a given amount of points for presentational purposes using the loyalty program’s points currency name/label and localization preferences.

This method requires points settings to be preloaded before use. Call Smile.preload() with pointsSettings before calling this method, or — if you initialize the JavaScript SDK yourself — include pointsSettings in the preload array during initialization.

Parameters

integer

required

An integer representing the amount of points to format.

object

Show properties

boolean

default:"true"

A boolean value specifying whether the loyalty program’s points label should be included in the returned string.

string

default:""

A string that will be included before the loyalty program’s points label in the returned string.

Returns

This method returns a String.

Key concepts

Smile object

SDK resources

Parameters

Returns

​Parameters

​Returns

Parameters

Returns