Zero pad milliseconds with 3 digits?

[jetersen]

Sorry for not spending more time.

I would like to zero pad weeks, days, hours, minutes with two digits and then zero pad milliseconds with 3 digits.

So you would get below output from the countdown().toString

01 day, 09 hours, 05 minutes, 03 seconds and 005 milliseconds
08 days, 02 hours, 09 minutes, 16 seconds and 095 milliseconds

Perhaps the setLabels format function could provide number and unit of said number to then zero pad differently

[jetersen]

@mckamey Sorry for not being more detailed. I was asking a question and would be happy to implement it myself if you asked me to do so if it was not currently possible. I have added more details to the question.
I honestly thought the title was enough.

[jetersen]

I ended up avoiding using the toString or toHTML and just read the values off the timespan object.

[jetersen]

Using toString method or toHTML method on a timespan object I would like to pad numbers with zero.

Milliseconds should always have a length of three digits. while the rest of the units should always have a length of two digits.
So that countdown().toString always shows 50 milliseconds as 050 milliseconds or 5 weeks as 05.

[mckamey]

As for custom formatting, including padding with zeros, you can pass in a callback like this to do your formatting:

#4 (comment)

[mckamey]

Or even better, there is a formatter function option here:

https://github.com/mckamey/countdownjs/blob/master/countdown.js#L1300-L1305

I knew I had added something like that but it looks like the readme wasn't updated.

[jetersen]

Well formatter callback only gives me the value so the function I provide applies to all values, and what am fishing after is being able to retrieve the unit type of the value being formatted so I can write a function that can treat them differently.

[mckamey]

In the options formatNumber receives only value but formatter gets value and units.

[jetersen]

@mckamey awesome 😅 The readme does mention the formatter but not that it returns value and units 👍

If you like I can send a PR that updates the text about formatNumber and formatter.
Noticed that the readme mentions the formatter in the context of setLabels which is deprecated since version 2.6.0.

countdownjs/countdown.js

Lines 1322 to 1344 in cb5b187

	/**
	* Override the unit labels.
	* @public
	* @param {string|Array=} singular a pipe ('|') delimited list of singular unit name overrides
	* @param {string|Array=} plural a pipe ('|') delimited list of plural unit name overrides
	* @param {string=} last a delimiter before the last unit (default: ' and ')
	* @param {string=} delim a delimiter to use between all other units (default: ', ')
	* @param {string=} empty a label to use when all units are zero (default: '')
	* @param {function(number):string=} formatNumber a function which formats numbers as a string
	* @param {function(number,number):string=} formatter a function which formats a number/unit pair as a string
	* @deprecated since version 2.6.0
	*/
	countdown.setLabels = function(singular, plural, last, delim, empty, formatNumber, formatter) {
	setFormat({
	singular: singular,
	plural: plural,
	last: last,
	delim: delim,
	empty: empty,
	formatNumber: formatNumber,
	formatter: formatter
	});
	};

https://github.com/mckamey/countdownjs/blob/master/README.md#localization
formatter is a function which takes a number and returns a string (default uses Number.toString()), allowing customization of the way numbers are formatted, e.g., commas every 3 digits or some unique style that is specific to your locale.

[mckamey]

Yeah those are now set via countdown.setFormat / countdown.resetFormat, since it does more than labels.

A PR updating the readme would be great. Thanks.