edit: Nevermind, I messed up.

When I try to parse something like 1000*60 (multiply)

parse("1000*60");

Instead of returning 60000(which is 1 min), it returns 1060

It also happened when trying to parse something like 10000/10 (division)

parse("10000/10");

Instead of returning 1000(which is 1 sec), it returns 10010

const parseDuration = require("parse-duration")

console.log('not duration string') # ==> undefined

https://runkit.com/trim21/npm-parse-duration-1

but return value in type definition is number

Hi, any thoughts on supporting spelled out numbers. E.g. "one hour" and "twenty four days"?

Now I can use multiple ways to get number of milliseconds for singular forms of string:

parse('1h') // 3600000
parse('1 h') // 3600000
parse('1hour') // 3600000
parse('1 hour') // 3600000
parse('1hours') // 3600000
parse('1 hours') // 3600000
// ...

But I can't do in the following way without integer:

parse('h') // 0, should be 3600000
parse('hour') // 0, should be 3600000

There's another unicode character for microseconds. I ran into this with gVisor printing out this character.

If you use this site you can see the character codes:

http://www.mauvecloud.net/charsets/CharCodeFinder.html

Paste this:
µμ

And you'll see two separate codes.

There is a couple wishes in issues to support dotnet TimeSpan and ISO8061 duration formats #29, #30:

• [-][d.]hh:mm:ss[.fffffff]
• [-][d:]h:mm:ss[.FFFFFFF]
• [-]d:hh:mm:ss.fffffff
• P[YYYY]-[MM]-[DD]T[hh]:[mm]:[ss]
• PYYYYMMDDThhmmss
• PnYnMnDTnHnMnS
• PnW

👍🏼 Supporting them would simplify life for generic parse-duration user: migrating data, reduce API friction (audio, video) etc.
👍🏼 That would be the most compact generic-case solution.
👎🏼 Mixing concerns: now we focus on human readable durations, eg. entered by user in UI/CLI/docs/APIs. Inflating package to all cases can become costly.
👎🏼 Maintenance burden: once somebody submits new duration format, we gotta update the package.
👎🏼 It complicates implementation, inflates size somewhat, also some performance loss - price that paid by every current user.

Hi,

is it possible to add support for ISO 8601 formatted duration strings?
I have to add moment.js library as a dependency (besides yours) just for parsing this format.

More details: https://en.wikipedia.org/wiki/ISO_8601#Durations

Hi,

I ran the example with 0.4.2 and got the same error
https://codesandbox.io/s/misty-framework-1u19b?file=/src/index.ts

Thanks
Lior

Full error:

Could not find a declaration file for module 'parse-duration'. '/home/rajas/folder-size-checker/node_modules/.pnpm/[email protected]/node_modules/parse-duration/index.mjs' implicitly has an 'any' type.
  Try `npm i --save-dev @types/parse-duration` if it exists or add a new declaration (.d.ts) file containing `declare module 'parse-duration';`ts(7016)

Possible causes:

• .d.ts file is not being resolved as typings for the .mjs file
• package.json doesn't correctly include types

How can I set what is treated as a decimal separator? I can easily add support for units in more languages, but half of the world uses comma as a decimal separator and I can't seem to find a way to switch it.

Right now:
parse('1.500 seconds') - resulting in one and a half second
parse('1,500 seconds') - resulting in one and a half thousand seconds

I need:
parse('1,500 seconds') - resulting in one and a half second

I understand that it's impossible to parse it both ways, but at least what we could have is a way to override the decimal separator based on our language we use in our apps. Maybe similar to how we add language specific units?
parse['decimalSeparator'] = ',';

Hi.
Thanks for parse-duration, I've been using it in loads of my libraries, however it's started failing under Node 14. I'm probably missing something obvious, getting the following error...

$ node --version
v14.2.0
$ node
Welcome to Node.js v14.2.0.
Type ".help" for more information.
> const parse = require('parse-duration');
Uncaught:
Error [ERR_PACKAGE_PATH_NOT_EXPORTED]: No "exports" main resolved in /Users/steve/Development/cressie176/pipsqueak/node_modules/parse-duration/package.json
    at resolveExportsTarget (internal/modules/cjs/loader.js:596:11)
    at applyExports (internal/modules/cjs/loader.js:454:14)
    at resolveExports (internal/modules/cjs/loader.js:507:23)
    at Function.Module._findPath (internal/modules/cjs/loader.js:635:31)
    at Function.Module._resolveFilename (internal/modules/cjs/loader.js:1007:27)
    at Function.Module._load (internal/modules/cjs/loader.js:890:27)
    at Module.require (internal/modules/cjs/loader.js:1080:19)
    at require (internal/modules/cjs/helpers.js:72:18)
    at repl:1:15
    at Script.runInThisContext (vm.js:131:20) {
  code: 'ERR_PACKAGE_PATH_NOT_EXPORTED'
}

Any ideas?

Here is awesome package using the same functionality: https://github.com/compute-io/incrdatespace

I think it would be winning for both to cross-test cases and make integration.

The cases:

• ms, millisecond, milliseconds
• s, sec, secs, second, seconds
• m, min, mins, minute, minutes
• h, hr, hrs, hour, hours
• d, day, days
• w, wk, wks, week, weeks
• b, month, months
• y, yr, yrs, year, years

Anyways there is no tests, so mb worth adding.
Just for note.

cc @kgryte is there any sense in that?

When parsing -1h30m it will return -30m in ms . ( I think because it does -1h + 30m = -30m )

here is a little testing runkit : https://runkit.com/thib3113/parse-duration-negative-bug

tested with version 1.0.3

Dear Jake

Thanks for your code. I would like to inform you on two cases I recently encountered:

let n = parse(1)

index.js:62 str = str.replace(/(\d),(\d)/g, '$1$2') ^ TypeError: str.replace is not a function

let n = parse('1')   // => null

In both cases I would rather expect a returned value of 1.

Regards
H. R. Baer

How to recreate the issue:

1. npm install parse-duration
2. open parse-duration in node_modules and see that "index.d.ts" is not a part of the package

Thanks

As we known, the dist file was commonjs styled, but d.ts use ESM to describe it.

my tsconfig

{
  "compilerOptions": {
    "module": "commonjs",
    "declaration": true,
    "removeComments": true,
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "importHelpers": true,
    "target": "es2017",
    "sourceMap": true,
    "outDir": "./dist",
    "strict": true,
    "noImplicitAny": true,
    "incremental": true,
    "resolveJsonModule": true,
    "types": [
      "node",
      "jest"
    ],
    "lib": [
      "ESNext",
      "ScriptHost",
    ]
  },
  "exclude": ["node_modules", "dist"]
}

source code in .ts file

import parse from "parse-duration";

parse("30 mins");

target (compiled by tsc) in .js file

const parse_duration_1 = tslib_1.__importDefault(require("parse-duration"));
parse_duration_1.default("30 mins");

Above code should have runtime error certainly

So we have to use esModuleInterop (maybe some other option needed?)

My Suggestion1 (Not Recommand)

Is it necessary？ I think if u can modify the d.ts file

to below code, we can drop esModuleInterop option

// ...Units defintion
declare function parse (str: string, format?: Units): number | null
export = parse

then we can easily use import parse = require("parse-duration")

My suggestion2 (Recommand)

forget suggestion1 then just simple add module.exports.default = parse in your index.js

the current type system is not as flexible as parsing.

doing

var parseDuration = require("[email protected]")

console.log(parseDuration('10 seconds', 'seconds'))

will print NaN
but doing

var parseDuration = require("[email protected]")

console.log(parseDuration('10 seconds', 's'))

will print 10, the correct answer.

I believe that the unit types should be as flexible as the parsing types as not having it that way can lead to errors and weirdness.

Hi,

is it possible to add support for .NET TimeSpan strings?
I have to add moment.js library as a dependency (besides yours) just for parsing this format.

More details: https://docs.microsoft.com/en-US/dotnet/standard/base-types/standard-timespan-format-strings

Wonderful module, very useful.
We should have unit validation also. Like parse('I have 2 mangoes and 5 apples') should return null.

Hi,

According to the d.ts the parse function return a number but actually parse(1) or parse(undefined) returns null
so
export default function parse (str: string): number
should be
export default function parse (str: string): number || null

thanks
Lior

Import with
import parse from "parse-duration";
or
import {parse} from "parse-duration";

use it:
parse("10s")

you will get
"parse_duration_1.default is not a function"

Can you please provide a type script example of how to use parse-duration?

Thanks,
Lior

parse(undefined) throws exception instead of returning null

tested on version 0.3.0

Thanks

I create a typescript version of this repo, I can give you a PR if you want, if not just ignore and close this issue. Thanks.

Please see TS project:
https://codesandbox.io/s/misty-framework-1u19b?file=/src/index.ts

It can be solved by adding
"esModuleInterop": true
To the tsconfig.json but a namespace solution is a bad practice

Thanks
Lior

According to https://www.typescriptlang.org/docs/handbook/declaration-files/templates/module-function-d-ts.html, this is as simple as

// ./index.d.ts

export = parse

/**
 * convert `str` to ms
 */
function parse (str: string): number

And, add "typings": "index.d.ts", in your package.json. Then, upload to NPM.

Might create a Pull Request later. Hope this package will be actively maintained.

Anyways, for anyone reading this, you can also create declaration.d.ts with

declare module 'parse-duration' {
  export = parse

  /**
   * convert `str` to ms
   */
  function parse (str: string): number
}

Unfortunately current type definition is only for the function. There is no way to add more units cause there is no index signature defined and parse['anything'] = generates error.

.d.ts file should have something like this instead:

declare const parse: ((input: string, format?: Units) => number) & {
  [key: string]: number | null;
};

export default parse;

I used the above to overwrite the type and it works fine for me.

Hi, jkroso

Although we can use parse.newUnit to extend more unit, your regexp may limit the unit as [a-zµμ]

I suggest it could change to some else such as [^\d\s] to make more possibility

The change is just example, It fail to pass test case because of the noisy word

So a safer way could be either of follow:

• Check the last capture group

  1. Give the parse object a method called registerUnit, it will push all unit into an array
  2. The last capture group (unit) will check if it contains any unit

• Dynamically create regular expressions by current units collection array

If u agree, I can do some job(by the way, improve the .d.ts file to allow us extend units under typescript) and take a pr in several days

I use parse-duration package inside react project.

When I execute yarn build I see this error:

parse-duration/index.mjs: symbol.charCodeAt is not a function at Array.map (<anonymous>)

I tried with version 1.0.2 and with 1.0.0