Skip to content

Commit 6904e7a

Browse files
authored
Add some JSDoc comments
See [#233][0]. [0]: #233 Signed-off-by: wyrapeseed <wyrapeseed@outlook.com>
1 parent 7d96bbc commit 6904e7a

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

humanize-duration.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1511,7 +1511,8 @@
15111511
/**
15121512
* Create a humanizer, which lets you change the default options.
15131513
*
1514-
* @param {Options} [passedOptions]
1514+
* @param {Options} [passedOptions] Options to customize the humanizer
1515+
* @returns {(ms: number, humanizerOptions: Options) => string} A function that humanizes durations
15151516
*/
15161517
function humanizer(passedOptions) {
15171518
/**
@@ -1564,6 +1565,11 @@
15641565
* This is a wrapper around the default humanizer.
15651566
*/
15661567
var humanizeDuration = assign(humanizer({}), {
1568+
/**
1569+
* Get a list of supported languages.
1570+
*
1571+
* @returns {string[]} An array of language codes
1572+
*/
15671573
getSupportedLanguages: function getSupportedLanguages() {
15681574
var result = [];
15691575
for (var language in LANGUAGES) {

0 commit comments

Comments
 (0)