extended-library / extended Goto Github PK

🚀 Description

Possibilities of duration-strings and the possible syntax cannot be found in a concise, simple manner.

The term duration-string refers to the main argument of duration (e.g.: '1h 2min 3sec').

💡 Solution

Write a tutorial doc, either in this repository, or as a separate, tutorial article with a link to this repo about the possibilities and the usage of duration-strings.

💬 Additional Context

This issue can be linked and resolved with #11.

• init rollup
• create test
• setup coverage
• setup doc generation
• finalize TravisCI

Negative durations are handled currently like in the 2. option!

Add an option to handle negative durations:

• 1.: turn it off, e.g.: duration(-1) === 0
• 2.: or handle it, like e.g.: duration(-1) === -1

• readme badges and links

• readme decor: https://www.npmjs.com/package/year-range

• own social sites, project's twitter page

• readme - Usage section - basic examples, refactor index.js too

• author section

• readme icons

• .github dir and docs

• finish logo and media with docs and license

• readme structure

If the return unit is provided as 2nd or 3rd argument by specifying the bare unit (e.g.:'sec', 'hours', 'days', etc.), accept it as a return unit shorthand ({ unit: 'ms .. weeks' }).

For example, instead of:

duration('1 day', { unit: 'sec' }) // === 86400 in seconds

accept the return unit as 2nd or 3rd (with fallback) argument:

duration('1 day', 'sec')  // === 86400 in seconds
duration('1 day', '0', 'sec')  // === 86400 in seconds

Add a range feature for 2 given duration, which 2 given duration values will be the random min and max values, inclusive [min, max].

duration('1s-2s') // will return between 1s and 2s randomly (including 1s and 2s too)
duration('55m-1.5h') // will return between 55m and 1.5h (or 90m) randomly

Add more units with configurable durations (e.g.: how long a year should actually be - 365 days exactly, or 365.25 days, or just use from option to calculate from):

• months ('month', 'months')
• quarters ('q', 'qrt', 'quarter', 'quarters')
• years ('y', 'yr', 'year', 'years')

For example, if 1 year is given, by default, calculate a year from the time of calling the function, e.g.: duration('1 year') is called on 2020-01-30 12:00:00, in this case 1 year won't be ~365.25 days, but calculate the actual milliseconds between 2020-01-30 12:00:00 and 2021-01-30 12:00:00 - (in this case it's 366 days === 31622400000 milliseconds).

Also consider providing a calculate duration from option, e.g.:

// default value
duration('1 year', { from: 'now' })

// custom date (string as human-readable date)
duration('1 year', { from: '2020-01-30 12:00:00' })

// custom date (a number in milliseconds? or seconds? from epoch) - consider ? later
duration('1 year', { from: 1580385600000 }) // 2020-01-30 12:00:00 GMT in epoch milliseconds

🚀 Description

duration-string can be extracted as a separate, open standard package and repository for better testing and documentation.

💡 Solution

Extract duration-string as @standards/duration-string on NPM and also on GitHub.

🐞 Description

Starting a composite duration with a minus sign will only treat the first block as negative.

Example:
1h30m => 5400000 CORRECT
-1h30m => -1800000 WRONG: This translates to -30 minutes
-1h30m => -5400000 CORRECT but weird

💡 Expected Behavior

The entire duration is set to negative, so for example, having -1h30m should return -5400000. This is currently achieved with -1h-30m, which is very weird.

↩️ Is This a Regression?

No.

🔬 Minimal Reproduction

Steps to reproduce the behavior:

1. Use a composite duration that begins with a minus sign, but with no subsequent minus signs afterwards.

🔥 Error or Exception

If there's an error or an exception, please share it below:

None.

🌍 Environment

Describe your relevant environment (device, OS, browser, Node.js, packages, etc.):

Node v14.15.4
NPM 6.14.10
Windows 10 64bit
@standards/duration: 1.1.3

🖼️ Screenshots

💬 Anything Else?

None.

Add a ~ modifier for the given duration, that signals, that the given duration should be a range with min and max values based on the given duration with 10% difference.

duration('~10s') // equals to duration('9s-11s')
duration('~1m') // equals to duration('0.9m-1.1m') or duration('54s-66s')
duration('~2.5s') // equals to duration('2.25s-2.75s')