diff --git a/.README.md b/.README.md new file mode 100644 index 0000000..ee1aabb --- /dev/null +++ b/.README.md @@ -0,0 +1,70 @@ +# A natural language parser for dates, times, and durations + +[![NPM Version][npm-image]][npm-url] +[![Downloads Stats][npm-downloads]][npm-url] + +A tiny utility library **with no dependencies** that parses natural language +**dates**, **times**, and **intervals** to either a `Date` instance or a +numerical value in milliseconds. Here are some examples of possible inputs: + +- **two weeks ago** +- **1 day ago** +- **in 2 hours and 5 minutes** +- **in a month** +- **2018-01-01T00:00:00.000Z** + +## Installation + +```bash +npm i --save time-speak +``` + +## Usage + +Import the `parse` function call it with a string containing a natural language +representation of either a time in the future, past, or a duration. The return +value is a timestamp in milliseconds if the input is a duration, otherwise it +is a `Date` instance. + +```js +import { parse } from 'time-speak' + +const pastDate = parse('2 days and 4 hours ago') +const pastDateWithNumberWords = parse('two days and four hours ago') +const futureDate = parse('in 4 hours') +const durationMS = parse('6 months') + +console.log({ + pastDateWithNumberWords, // 2023-12-19T13:02:39.768Z + pastDate, // 2023-12-19T13:02:39.768Z + futureDate, // 2023-12-21T21:02:39.768Z + durationMS // 15552000000 +}) +``` + +## API Reference + +> The standalone JSDoc reference can be found in [DOCUMENTATION.md](DOCUMENTATION.md) + +<%= api %> + +## Release History + +See _[CHANGELOG.md](./CHANGELOG.md)_ for more information. + +## License + +Distributed under the **MIT** license. See [LICENSE.md](./LICENSE.md) for more +information. + +## Contributing + +1. Fork it +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create a new Pull Request + +[npm-image]: https://img.shields.io/npm/v/time-speak.svg?style=flat-square +[npm-url]: https://npmjs.org/package/time-speak +[npm-downloads]: https://img.shields.io/npm/dm/time-speak.svg?style=flat-square diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md new file mode 100644 index 0000000..b0f498b --- /dev/null +++ b/DOCUMENTATION.md @@ -0,0 +1,136 @@ +## Classes + +
+
InvalidInputError
+

Error thrown when the input cannot be parsed to a date or duration. It +optionally accepts a detail parameter that can be used to provide more +information about why parsing failed.

+
+
+ +## Members + +
+
TimeUnit
+

A mapping of time units to their millisecond values.

+
+
TimeUnitPlural
+

A mapping of plural time units to their singular counterparts.

+
+
+ +## Functions + +
+
parse(input) ⇒
+

Parses a string into a Date or number of milliseconds. The string can +describe the date in natural language (e.g. "tomorrow", "in 2 hours and 3 +minutes", "a month ago", etc.) or be a valid date string (e.g. "2018-01-01").

+
+
+ + + +## InvalidInputError +Error thrown when the input cannot be parsed to a date or duration. It +optionally accepts a `detail` parameter that can be used to provide more +information about why parsing failed. + +**Kind**: global class +**Access**: public + +* [InvalidInputError](#InvalidInputError) + * [new InvalidInputError(input, detail)](#new_InvalidInputError_new) + * [._input](#InvalidInputError+_input) + * [._detail](#InvalidInputError+_detail) + * [.detail](#InvalidInputError+detail) ⇒ + * [.input](#InvalidInputError+input) ⇒ + + + +### new InvalidInputError(input, detail) +Create a new `InvalidInputError` instance with the given `input`, +optionally providing a `detail` parameter to describe why parsing failed. +The `detail` parameter will be included in the error message if provided. + + +| Param | Description | +| --- | --- | +| input | The input that could not be parsed | +| detail | A more detailed description of the error | + + + +### invalidInputError.\_input +The input that could not be parsed. + +**Kind**: instance property of [InvalidInputError](#InvalidInputError) + + +### invalidInputError.\_detail +An optional detailed description of the reason why parsing failed. + +**Kind**: instance property of [InvalidInputError](#InvalidInputError) + + +### invalidInputError.detail ⇒ +Get the detail explaining why parsing failed. If no detail was provided, +it will return an empty string. + +**Kind**: instance property of [InvalidInputError](#InvalidInputError) +**Returns**: The detail string. + + +### invalidInputError.input ⇒ +Get the original input that could not be parsed. + +**Kind**: instance property of [InvalidInputError](#InvalidInputError) +**Returns**: The input string. + + +## TimeUnit +A mapping of time units to their millisecond values. + +**Kind**: global variable + + +## TimeUnitPlural +A mapping of plural time units to their singular counterparts. + +**Kind**: global variable + + +## parse(input) ⇒ +Parses a string into a `Date` or number of milliseconds. The string can +describe the date in natural language (e.g. "tomorrow", "in 2 hours and 3 +minutes", "a month ago", etc.) or be a valid date string (e.g. "2018-01-01"). + +**Kind**: global function +**Returns**: The parsed date or number of milliseconds. +**Throws**: + +- [InvalidInputError](#InvalidInputError) +This exception is thrown if the input is invalid. + +**Access**: public + +| Param | Description | +| --- | --- | +| input | The string to parse. | + +**Example** +Here are some example invocations: +``` +const ... = parse('1 day ago') +const ... = parse('three days ago') +const ... = parse('in 2 hours and 3 minutes') +const ... = parse('a month') +const ... = parse('2018-01-01') +const ... = parse('2018-01-01T00:00:00.000Z') +``` +**Example** +Here are some example invocations that throw an exception: +``` +parse('in 2 hours and 3 minutes ago') +parse('a month in the past') +``` diff --git a/README.md b/README.md index fdad6c8..d508b4f 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,7 @@ A tiny utility library **with no dependencies** that parses natural language **dates**, **times**, and **intervals** to either a `Date` instance or a numerical value in milliseconds. Here are some examples of possible inputs: +- **two weeks ago** - **1 day ago** - **in 2 hours and 5 minutes** - **in a month** @@ -29,16 +30,160 @@ is a `Date` instance. import { parse } from 'time-speak' const pastDate = parse('2 days and 4 hours ago') +const pastDateWithNumberWords = parse('two days and four hours ago') const futureDate = parse('in 4 hours') const durationMS = parse('6 months') console.log({ - pastDate, // 2023-12-19T13:02:39.768Z - futureDate, // 2023-12-21T21:02:39.768Z - durationMS // 15552000000 + pastDateWithNumberWords, // 2023-12-19T13:02:39.768Z + pastDate, // 2023-12-19T13:02:39.768Z + futureDate, // 2023-12-21T21:02:39.768Z + durationMS // 15552000000 }) ``` +## API Reference + +> The standalone JSDoc reference can be found in [DOCUMENTATION.md](DOCUMENTATION.md) + +## Classes + +
+
InvalidInputError
+

Error thrown when the input cannot be parsed to a date or duration. It +optionally accepts a detail parameter that can be used to provide more +information about why parsing failed.

+
+
+ +## Members + +
+
TimeUnit
+

A mapping of time units to their millisecond values.

+
+
TimeUnitPlural
+

A mapping of plural time units to their singular counterparts.

+
+
+ +## Functions + +
+
parse(input) ⇒
+

Parses a string into a Date or number of milliseconds. The string can +describe the date in natural language (e.g. "tomorrow", "in 2 hours and 3 +minutes", "a month ago", etc.) or be a valid date string (e.g. "2018-01-01").

+
+
+ + + +## InvalidInputError +Error thrown when the input cannot be parsed to a date or duration. It +optionally accepts a `detail` parameter that can be used to provide more +information about why parsing failed. + +**Kind**: global class +**Access**: public + +* [InvalidInputError](#InvalidInputError) + * [new InvalidInputError(input, detail)](#new_InvalidInputError_new) + * [._input](#InvalidInputError+_input) + * [._detail](#InvalidInputError+_detail) + * [.detail](#InvalidInputError+detail) ⇒ + * [.input](#InvalidInputError+input) ⇒ + + + +### new InvalidInputError(input, detail) +Create a new `InvalidInputError` instance with the given `input`, +optionally providing a `detail` parameter to describe why parsing failed. +The `detail` parameter will be included in the error message if provided. + + +| Param | Description | +| --- | --- | +| input | The input that could not be parsed | +| detail | A more detailed description of the error | + + + +### invalidInputError.\_input +The input that could not be parsed. + +**Kind**: instance property of [InvalidInputError](#InvalidInputError) + + +### invalidInputError.\_detail +An optional detailed description of the reason why parsing failed. + +**Kind**: instance property of [InvalidInputError](#InvalidInputError) + + +### invalidInputError.detail ⇒ +Get the detail explaining why parsing failed. If no detail was provided, +it will return an empty string. + +**Kind**: instance property of [InvalidInputError](#InvalidInputError) +**Returns**: The detail string. + + +### invalidInputError.input ⇒ +Get the original input that could not be parsed. + +**Kind**: instance property of [InvalidInputError](#InvalidInputError) +**Returns**: The input string. + + +## TimeUnit +A mapping of time units to their millisecond values. + +**Kind**: global variable + + +## TimeUnitPlural +A mapping of plural time units to their singular counterparts. + +**Kind**: global variable + + +## parse(input) ⇒ +Parses a string into a `Date` or number of milliseconds. The string can +describe the date in natural language (e.g. "tomorrow", "in 2 hours and 3 +minutes", "a month ago", etc.) or be a valid date string (e.g. "2018-01-01"). + +**Kind**: global function +**Returns**: The parsed date or number of milliseconds. +**Throws**: + +- [InvalidInputError](#InvalidInputError) +This exception is thrown if the input is invalid. + +**Access**: public + +| Param | Description | +| --- | --- | +| input | The string to parse. | + +**Example** +Here are some example invocations: +``` +const ... = parse('1 day ago') +const ... = parse('three days ago') +const ... = parse('in 2 hours and 3 minutes') +const ... = parse('a month') +const ... = parse('2018-01-01') +const ... = parse('2018-01-01T00:00:00.000Z') +``` +**Example** +Here are some example invocations that throw an exception: +``` +parse('in 2 hours and 3 minutes ago') +parse('a month in the past') +``` + + ## Release History See _[CHANGELOG.md](./CHANGELOG.md)_ for more information. diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md index d2cf3a0..15e58f4 100644 --- a/docs/CHANGELOG.md +++ b/docs/CHANGELOG.md @@ -2,6 +2,8 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. +## [1.7.0](https://github.com/f3rno64/time-speak/compare/v1.6.0...v1.7.0) (2024-01-15) + ## [1.6.0](https://github.com/f3rno64/time-speak/compare/v1.5.1...v1.6.0) (2023-12-22) ### [1.5.1](https://github.com/f3rno64/time-speak/compare/v1.5.0...v1.5.1) (2023-12-22) diff --git a/docs/classes/InvalidInputError.html b/docs/classes/InvalidInputError.html index d5cf11e..d967924 100644 --- a/docs/classes/InvalidInputError.html +++ b/docs/classes/InvalidInputError.html @@ -1,7 +1,7 @@ -InvalidInputError | time-speak

Class InvalidInputError

Error thrown when the input cannot be parsed to a date or duration. It +InvalidInputError | time-speak

Class InvalidInputError

Error thrown when the input cannot be parsed to a date or duration. It optionally accepts a detail parameter that can be used to provide more information about why parsing failed.

-

Hierarchy

  • Error
    • InvalidInputError

Constructors

constructor +

Hierarchy

  • Error
    • InvalidInputError

Constructors

constructor

Properties

_detail _input cause? @@ -18,14 +18,14 @@ The detail parameter will be included in the error message if provided.

Parameters

  • input: string

    The input that could not be parsed

  • Optional detail: string

    A more detailed description of the error

    -

Returns InvalidInputError

Properties

Private _detail

_detail: string

An optional detailed description of the reason why parsing failed.

-

Private _input

_input: string

The input that could not be parsed.

-

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

    • (err, stackTraces): any

    • Optional override for formatting stack traces

      +

Returns InvalidInputError

Properties

Private _detail

_detail: string

An optional detailed description of the reason why parsing failed.

+

Private _input

_input: string

The input that could not be parsed.

+

Optional cause

cause?: unknown

message

message: string

name

name: string

Optional stack

stack?: string

Static Optional prepareStackTrace

prepareStackTrace?: ((err, stackTraces) => any)

Type declaration

Static stackTraceLimit

stackTraceLimit: number

Accessors

detail

  • get detail(): string

  • Get the detail explaining why parsing failed. If no detail was provided, it will return an empty string.

    Returns string

    The detail string.

    -

input

input

Methods

Static captureStackTrace

Methods

Static captureStackTrace

  • captureStackTrace(targetObject, constructorOpt?): void

  • Create .stack property on a target object

    Parameters

    • targetObject: object
    • Optional constructorOpt: Function

    Returns void

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/functions/parse.html b/docs/functions/parse.html index 8e3e3bf..6e6e33a 100644 --- a/docs/functions/parse.html +++ b/docs/functions/parse.html @@ -1,4 +1,4 @@ -parse | time-speak

Function parse

  • parse(input): number | Date

  • Parses a string into a Date or number of milliseconds. The string can +parse | time-speak

    Function parse

    • parse(input): number | Date

    • Parses a string into a Date or number of milliseconds. The string can describe the date in natural language (e.g. "tomorrow", "in 2 hours and 3 minutes", "a month ago", etc.) or be a valid date string (e.g. "2018-01-01").

      Parameters

      • input: string

        The string to parse.

        @@ -11,4 +11,4 @@

        Example

        Here are some example invocations:

        Example

        Here are some example invocations that throw an exception:

        parse('in 2 hours and 3 minutes ago')
        parse('a month in the past')
        -

    Settings

    Member Visibility

    Theme

    \ No newline at end of file +

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 46db64d..e956794 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,9 +1,10 @@ -time-speak

time-speak

A natural language parser for dates, times, and durations

NPM Version +time-speak

time-speak

A natural language parser for dates, times, and durations

NPM Version Downloads Stats

A tiny utility library with no dependencies that parses natural language dates, times, and intervals to either a Date instance or a numerical value in milliseconds. Here are some examples of possible inputs:

    +
  • two weeks ago
  • 1 day ago
  • in 2 hours and 5 minutes
  • in a month
    • @@ -15,7 +16,111 @@ representation of either a time in the future, past, or a duration. The return value is a timestamp in milliseconds if the input is a duration, otherwise it is a Date instance.

    -
    import { parse } from 'time-speak'

    const pastDate = parse('2 days and 4 hours ago')
    const futureDate = parse('in 4 hours')
    const durationMS = parse('6 months')

    console.log({
      pastDate,    // 2023-12-19T13:02:39.768Z
      futureDate,  // 2023-12-21T21:02:39.768Z
      durationMS   // 15552000000
    })
+
    import { parse } from 'time-speak'

    const pastDate = parse('2 days and 4 hours ago')
    const pastDateWithNumberWords = parse('two days and four hours ago')
    const futureDate = parse('in 4 hours')
    const durationMS = parse('6 months')

    console.log({
      pastDateWithNumberWords,    // 2023-12-19T13:02:39.768Z
      pastDate,                   // 2023-12-19T13:02:39.768Z
      futureDate,                 // 2023-12-21T21:02:39.768Z
      durationMS                  // 15552000000
    })
+
    
+
    API Reference
    
+
    The standalone JSDoc reference can be found in DOCUMENTATION.md
    
+
    
+
    Classes
    
+
    InvalidInputError
    
+
    Error thrown when the input cannot be parsed to a date or duration. It
+optionally accepts a detail parameter that can be used to provide more
+information about why parsing failed.
    
+
    
+
    
+
+
    Members
    
+
    TimeUnit
    
+
    A mapping of time units to their millisecond values.
    
+
    
+
    TimeUnitPlural
    
+
    A mapping of plural time units to their singular counterparts.
    
+
    
+
    
+
+
    Functions
    
+
    parse(input) ⇒
    
+
    Parses a string into a Date or number of milliseconds. The string can
+describe the date in natural language (e.g. "tomorrow", "in 2 hours and 3
+minutes", "a month ago", etc.) or be a valid date string (e.g. "2018-01-01").
    
+
    
+
    
+
+
    
+
    InvalidInputError
    Error thrown when the input cannot be parsed to a date or duration. It
+optionally accepts a detail parameter that can be used to provide more
+information about why parsing failed.
    
+
    Kind: global class
    Access: public  
    
+
+
    
+
    new InvalidInputError(input, detail)
    Create a new InvalidInputError instance with the given input,
+optionally providing a detail parameter to describe why parsing failed.
+The detail parameter will be included in the error message if provided.
    
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
    ParamDescription
    inputThe input that could not be parsed
    detailA more detailed description of the error
    
+
    
+
    invalidInputError._input
    The input that could not be parsed.
    
+
    Kind: instance property of InvalidInputError
    
+
    invalidInputError._detail
    An optional detailed description of the reason why parsing failed.
    
+
    Kind: instance property of InvalidInputError
    
+
    invalidInputError.detail ⇒
    Get the detail explaining why parsing failed. If no detail was provided,
+it will return an empty string.
    
+
    Kind: instance property of InvalidInputError
    Returns: The detail string.
    
+
    invalidInputError.input ⇒
    Get the original input that could not be parsed.
    
+
    Kind: instance property of InvalidInputError
    Returns: The input string.
    
+
    TimeUnit
    A mapping of time units to their millisecond values.
    
+
    Kind: global variable
    
+
    TimeUnitPlural
    A mapping of plural time units to their singular counterparts.
    
+
    Kind: global variable
    
+
    parse(input) ⇒
    Parses a string into a Date or number of milliseconds. The string can
+describe the date in natural language (e.g. "tomorrow", "in 2 hours and 3
+minutes", "a month ago", etc.) or be a valid date string (e.g. "2018-01-01").
    
+
    Kind: global function
    Returns: The parsed date or number of milliseconds.
    Throws:
    
+
+
    Access: public  
    
+
+
+
+
+
+
+
+
+
+
+
+
    ParamDescription
    inputThe string to parse.
    
+
    Example
    Here are some example invocations:
    
+
    const ... = parse('1 day ago')
    const ... = parse('three days ago')
    const ... = parse('in 2 hours and 3 minutes')
    const ... = parse('a month')
    const ... = parse('2018-01-01')
    const ... = parse('2018-01-01T00:00:00.000Z')
+
    
+
    Example
    Here are some example invocations that throw an exception:
    
+
    parse('in 2 hours and 3 minutes ago')
    parse('a month in the past')
 
    
 
    Release History
    See CHANGELOG.md for more information.
    
 
    License
    Distributed under the MIT license. See LICENSE.md for more
@@ -27,4 +132,4 @@
 
  • Push to the branch (git push origin my-new-feature)
    • 
 
  • Create a new Pull Request
    • 
 
-

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

\ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html index a201ea6..13c9e42 100644 --- a/docs/modules.html +++ b/docs/modules.html @@ -1,3 +1,3 @@ -time-speak

time-speak

Index

Classes

InvalidInputError +time-speak

time-speak

Index

Classes

InvalidInputError

Functions

parse

Settings

Member Visibility

Theme

\ No newline at end of file diff --git a/package-lock.json b/package-lock.json index 8941c31..3ab20bb 100644 --- a/package-lock.json +++ b/package-lock.json @@ -27,6 +27,7 @@ "eslint": "^8.56.0", "eslint-plugin-tsdoc": "^0.2.17", "husky": "^8.0.3", + "jsdoc-to-markdown": "^8.0.0", "mocha": "^10.2.0", "nyc": "^15.1.0", "standard-version": "^9.5.0", @@ -812,6 +813,18 @@ "@jridgewell/sourcemap-codec": "^1.4.14" } }, + "node_modules/@jsdoc/salty": { + "version": "0.2.7", + "resolved": "https://registry.npmjs.org/@jsdoc/salty/-/salty-0.2.7.tgz", + "integrity": "sha512-mh8LbS9d4Jq84KLw8pzho7XC2q2/IJGiJss3xwRoLD1A+EE16SjN4PfaG4jRCzKegTFLlN0Zd8SdUPE6XdoPFg==", + "dev": true, + "dependencies": { + "lodash": "^4.17.21" + }, + "engines": { + "node": ">=v12.0.0" + } + }, "node_modules/@microsoft/tsdoc": { "version": "0.14.2", "resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz", @@ -935,6 +948,28 @@ "integrity": "sha512-5+fP8P8MFNC+AyZCDxrB2pkZFPGzqQWUzpSeuuVLvm8VMcorNYavBqoFcxK8bQz4Qsbn4oUEEem4wDLfcysGHA==", "dev": true }, + "node_modules/@types/linkify-it": { + "version": "3.0.5", + "resolved": "https://registry.npmjs.org/@types/linkify-it/-/linkify-it-3.0.5.tgz", + "integrity": "sha512-yg6E+u0/+Zjva+buc3EIb+29XEg4wltq7cSmd4Uc2EE/1nUVmxyzpX6gUXD0V8jIrG0r7YeOGVIbYRkxeooCtw==", + "dev": true + }, + "node_modules/@types/markdown-it": { + "version": "12.2.3", + "resolved": "https://registry.npmjs.org/@types/markdown-it/-/markdown-it-12.2.3.tgz", + "integrity": "sha512-GKMHFfv3458yYy+v/N8gjufHO6MSZKCOXpZc5GXIWWy8uldwfmPn98vp81gZ5f9SVw8YYBctgfJ22a2d7AOMeQ==", + "dev": true, + "dependencies": { + "@types/linkify-it": "*", + "@types/mdurl": "*" + } + }, + "node_modules/@types/mdurl": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/@types/mdurl/-/mdurl-1.0.5.tgz", + "integrity": "sha512-6L6VymKTzYSrEf4Nev4Xa1LCHKrlTlYCBMTlQKFuddo1CvQcE52I0mwfOJayueUC7MJuXOeHTcIU683lzd0cUA==", + "dev": true + }, "node_modules/@types/minimist": { "version": "1.2.5", "resolved": "https://registry.npmjs.org/@types/minimist/-/minimist-1.2.5.tgz", @@ -1262,6 +1297,27 @@ "node": ">=6" } }, + "node_modules/ansi-escape-sequences": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/ansi-escape-sequences/-/ansi-escape-sequences-4.1.0.tgz", + "integrity": "sha512-dzW9kHxH011uBsidTXd14JXgzye/YLb2LzeKZ4bsgl/Knwx8AtbSFkkGxagdNOoh0DlqHCmfiEjWKBaqjOanVw==", + "dev": true, + "dependencies": { + "array-back": "^3.0.1" + }, + "engines": { + "node": ">=8.0.0" + } + }, + "node_modules/ansi-escape-sequences/node_modules/array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true, + "engines": { + "node": ">=6" + } + }, "node_modules/ansi-regex": { "version": "5.0.1", "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-5.0.1.tgz", @@ -1335,6 +1391,15 @@ "integrity": "sha512-8+9WqebbFzpX9OR+Wa6O29asIogeRMzcGtAINdpMHHyAg10f05aSFVBbcEqGf/PXw1EjAZ+q2/bEBg3DvurK3Q==", "dev": true }, + "node_modules/array-back": { + "version": "6.2.2", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-6.2.2.tgz", + "integrity": "sha512-gUAZ7HPyb4SJczXAMUXMGAvI976JoK3qEx9v1FTmeYuJj0IBiaKttG1ydtGKdkfqWkIkouke7nG8ufGy77+Cvw==", + "dev": true, + "engines": { + "node": ">=12.17" + } + }, "node_modules/array-ify": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/array-ify/-/array-ify-1.0.0.tgz", @@ -1383,6 +1448,12 @@ "node": ">=8" } }, + "node_modules/bluebird": { + "version": "3.7.2", + "resolved": "https://registry.npmjs.org/bluebird/-/bluebird-3.7.2.tgz", + "integrity": "sha512-XpNj6GDQzdfW+r2Wnn7xiSAd7TM3jzkxGXBGTtWKuSXv1xUV+azxAm8jdWZN06QTQk+2N2XB9jRDkvbmQmcRtg==", + "dev": true + }, "node_modules/brace-expansion": { "version": "1.1.11", "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", @@ -1449,6 +1520,29 @@ "integrity": "sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==", "dev": true }, + "node_modules/cache-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/cache-point/-/cache-point-2.0.0.tgz", + "integrity": "sha512-4gkeHlFpSKgm3vm2gJN5sPqfmijYRFYCQ6tv5cLw0xVmT6r1z1vd4FNnpuOREco3cBs1G709sZ72LdgddKvL5w==", + "dev": true, + "dependencies": { + "array-back": "^4.0.1", + "fs-then-native": "^2.0.0", + "mkdirp2": "^1.0.4" + }, + "engines": { + "node": ">=8" + } + }, + "node_modules/cache-point/node_modules/array-back": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-4.0.2.tgz", + "integrity": "sha512-NbdMezxqf94cnNfWLL7V/im0Ub+Anbb0IoZhvzie8+4HJ4nMQuzHuy49FkGYCJK2yAloZ3meiB6AVMClbrI1vg==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/caching-transform": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/caching-transform/-/caching-transform-4.0.0.tgz", @@ -1519,6 +1613,18 @@ } ] }, + "node_modules/catharsis": { + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/catharsis/-/catharsis-0.9.0.tgz", + "integrity": "sha512-prMTQVpcns/tzFgFVkVp6ak6RykZyWb3gu8ckUpd6YkTlacOd3DXGJjIpD4Q6zJirizvaiAjSSHlOsA+6sNh2A==", + "dev": true, + "dependencies": { + "lodash": "^4.17.15" + }, + "engines": { + "node": ">= 10" + } + }, "node_modules/chai": { "version": "4.3.10", "resolved": "https://registry.npmjs.org/chai/-/chai-4.3.10.tgz", @@ -1655,6 +1761,19 @@ "wrap-ansi": "^7.0.0" } }, + "node_modules/collect-all": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/collect-all/-/collect-all-1.0.4.tgz", + "integrity": "sha512-RKZhRwJtJEP5FWul+gkSMEnaK6H3AGPTTWOiRimCcs+rc/OmQE3Yhy1Q7A7KsdkG3ZXVdZq68Y6ONSdvkeEcKA==", + "dev": true, + "dependencies": { + "stream-connect": "^1.0.2", + "stream-via": "^1.0.4" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/color-convert": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-2.0.1.tgz", @@ -1673,6 +1792,103 @@ "integrity": "sha512-dOy+3AuW3a2wNbZHIuMZpTcgjGuLU/uBL/ubcZF9OXbDo8ff4O8yVp5Bf0efS8uEoYo5q4Fx7dY9OgQGXgAsQA==", "dev": true }, + "node_modules/command-line-args": { + "version": "5.2.1", + "resolved": "https://registry.npmjs.org/command-line-args/-/command-line-args-5.2.1.tgz", + "integrity": "sha512-H4UfQhZyakIjC74I9d34fGYDwk3XpSr17QhEd0Q3I9Xq1CETHo4Hcuo87WyWHpAF1aSLjLRf5lD9ZGX2qStUvg==", + "dev": true, + "dependencies": { + "array-back": "^3.1.0", + "find-replace": "^3.0.0", + "lodash.camelcase": "^4.3.0", + "typical": "^4.0.0" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/command-line-args/node_modules/array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/command-line-args/node_modules/typical": { + "version": "4.0.0", + "resolved": "https://registry.npmjs.org/typical/-/typical-4.0.0.tgz", + "integrity": "sha512-VAH4IvQ7BDFYglMd7BPRDfLgxZZX4O4TFcRDA6EN5X7erNJJq+McIEp8np9aVtxrCJ6qx4GTYVfOWNjcqwZgRw==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/command-line-tool": { + "version": "0.8.0", + "resolved": "https://registry.npmjs.org/command-line-tool/-/command-line-tool-0.8.0.tgz", + "integrity": "sha512-Xw18HVx/QzQV3Sc5k1vy3kgtOeGmsKIqwtFFoyjI4bbcpSgnw2CWVULvtakyw4s6fhyAdI6soQQhXc2OzJy62g==", + "dev": true, + "dependencies": { + "ansi-escape-sequences": "^4.0.0", + "array-back": "^2.0.0", + "command-line-args": "^5.0.0", + "command-line-usage": "^4.1.0", + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/command-line-tool/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, + "dependencies": { + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/command-line-usage": { + "version": "4.1.0", + "resolved": "https://registry.npmjs.org/command-line-usage/-/command-line-usage-4.1.0.tgz", + "integrity": "sha512-MxS8Ad995KpdAC0Jopo/ovGIroV/m0KHwzKfXxKag6FHOkGsH8/lv5yjgablcRxCJJC0oJeUMuO/gmaq+Wq46g==", + "dev": true, + "dependencies": { + "ansi-escape-sequences": "^4.0.0", + "array-back": "^2.0.0", + "table-layout": "^0.4.2", + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/command-line-usage/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, + "dependencies": { + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/common-sequence": { + "version": "2.0.2", + "resolved": "https://registry.npmjs.org/common-sequence/-/common-sequence-2.0.2.tgz", + "integrity": "sha512-jAg09gkdkrDO9EWTdXfv80WWH3yeZl5oT69fGfedBNS9pXUKYInVJ1bJ+/ht2+Moeei48TmSbQDYMc8EOx9G0g==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/commondir": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/commondir/-/commondir-1.0.1.tgz", @@ -1710,6 +1926,24 @@ "typedarray": "^0.0.6" } }, + "node_modules/config-master": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/config-master/-/config-master-3.1.0.tgz", + "integrity": "sha512-n7LBL1zBzYdTpF1mx5DNcZnZn05CWIdsdvtPL4MosvqbBUK3Rq6VWEtGUuF3Y0s9/CIhMejezqlSkP6TnCJ/9g==", + "dev": true, + "dependencies": { + "walk-back": "^2.0.1" + } + }, + "node_modules/config-master/node_modules/walk-back": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-2.0.1.tgz", + "integrity": "sha512-Nb6GvBR8UWX1D+Le+xUq0+Q1kFmRBIWVrfLnQAOmcpEzA9oAxwJ9gIr36t9TWYfzvWRvuMtjHiVsJYEkXWaTAQ==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/conventional-changelog": { "version": "3.1.25", "resolved": "https://registry.npmjs.org/conventional-changelog/-/conventional-changelog-3.1.25.tgz", @@ -2084,6 +2318,15 @@ "node": ">=6" } }, + "node_modules/deep-extend": { + "version": "0.6.0", + "resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz", + "integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==", + "dev": true, + "engines": { + "node": ">=4.0.0" + } + }, "node_modules/deep-is": { "version": "0.1.4", "resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.4.tgz", @@ -2144,6 +2387,29 @@ "node": ">=8" } }, + "node_modules/dmd": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/dmd/-/dmd-6.2.0.tgz", + "integrity": "sha512-uXWxLF1H7TkUAuoHK59/h/ts5cKavm2LnhrIgJWisip4BVzPoXavlwyoprFFn2CzcahKYgvkfaebS6oxzgflkg==", + "dev": true, + "dependencies": { + "array-back": "^6.2.2", + "cache-point": "^2.0.0", + "common-sequence": "^2.0.2", + "file-set": "^4.0.2", + "handlebars": "^4.7.7", + "marked": "^4.2.3", + "object-get": "^2.1.1", + "reduce-flatten": "^3.0.1", + "reduce-unique": "^2.0.1", + "reduce-without": "^1.0.1", + "test-value": "^3.0.0", + "walk-back": "^5.1.0" + }, + "engines": { + "node": ">=12" + } + }, "node_modules/doctrine": { "version": "3.0.0", "resolved": "https://registry.npmjs.org/doctrine/-/doctrine-3.0.0.tgz", @@ -2254,6 +2520,15 @@ "integrity": "sha512-MSjYzcWNOA0ewAHpz0MxpYFvwg6yjy1NG3xteoqz644VCo/RPgnr1/GGt+ic3iJTzQ8Eu3TdM14SawnVUmGE6A==", "dev": true }, + "node_modules/entities": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/entities/-/entities-2.1.0.tgz", + "integrity": "sha512-hCx1oky9PFrJ611mf0ifBLBRW8lUUVRlFolb5gWRfIELabBlbp9xZvrqZLZAs+NxFnbfQoeGd8wDkygjg7U85w==", + "dev": true, + "funding": { + "url": "https://github.com/fb55/entities?sponsor=1" + } + }, "node_modules/error-ex": { "version": "1.3.2", "resolved": "https://registry.npmjs.org/error-ex/-/error-ex-1.3.2.tgz", @@ -2546,6 +2821,28 @@ "node": "^10.12.0 || >=12.0.0" } }, + "node_modules/file-set": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/file-set/-/file-set-4.0.2.tgz", + "integrity": "sha512-fuxEgzk4L8waGXaAkd8cMr73Pm0FxOVkn8hztzUW7BAHhOGH90viQNXbiOsnecCWmfInqU6YmAMwxRMdKETceQ==", + "dev": true, + "dependencies": { + "array-back": "^5.0.0", + "glob": "^7.1.6" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/file-set/node_modules/array-back": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-5.0.0.tgz", + "integrity": "sha512-kgVWwJReZWmVuWOQKEOohXKJX+nD02JAZ54D1RRWlv8L0NebauKAaFxACKzB74RTclt1+WNz5KHaLRDAPZbDEw==", + "dev": true, + "engines": { + "node": ">=10" + } + }, "node_modules/fill-range": { "version": "7.0.1", "resolved": "https://registry.npmjs.org/fill-range/-/fill-range-7.0.1.tgz", @@ -2575,6 +2872,27 @@ "url": "https://github.com/avajs/find-cache-dir?sponsor=1" } }, + "node_modules/find-replace": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-replace/-/find-replace-3.0.0.tgz", + "integrity": "sha512-6Tb2myMioCAgv5kfvP5/PkZZ/ntTpVK39fHY7WkWBgvbeE+VHd/tZuZ4mrC+bxh4cfOZeYKVPaJIZtZXV7GNCQ==", + "dev": true, + "dependencies": { + "array-back": "^3.0.1" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/find-replace/node_modules/array-back": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-3.1.0.tgz", + "integrity": "sha512-TkuxA4UCOvxuDK6NZYXCalszEzj+TLszyASooky+i742l9TqsOdYCMJJupxRic61hwquNtppB3hgcuq9SVSH1Q==", + "dev": true, + "engines": { + "node": ">=6" + } + }, "node_modules/find-up": { "version": "5.0.0", "resolved": "https://registry.npmjs.org/find-up/-/find-up-5.0.0.tgz", @@ -2653,6 +2971,15 @@ } ] }, + "node_modules/fs-then-native": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/fs-then-native/-/fs-then-native-2.0.0.tgz", + "integrity": "sha512-X712jAOaWXkemQCAmWeg5rOT2i+KOpWz1Z/txk/cW0qlOu2oQ9H61vc5w3X/iyuUEfq/OyaFJ78/cZAQD1/bgA==", + "dev": true, + "engines": { + "node": ">=4.0.0" + } + }, "node_modules/fs.realpath": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", @@ -3423,6 +3750,111 @@ "js-yaml": "bin/js-yaml.js" } }, + "node_modules/js2xmlparser": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/js2xmlparser/-/js2xmlparser-4.0.2.tgz", + "integrity": "sha512-6n4D8gLlLf1n5mNLQPRfViYzu9RATblzPEtm1SthMX1Pjao0r9YI9nw7ZIfRxQMERS87mcswrg+r/OYrPRX6jA==", + "dev": true, + "dependencies": { + "xmlcreate": "^2.0.4" + } + }, + "node_modules/jsdoc": { + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/jsdoc/-/jsdoc-4.0.2.tgz", + "integrity": "sha512-e8cIg2z62InH7azBBi3EsSEqrKx+nUtAS5bBcYTSpZFA+vhNPyhv8PTFZ0WsjOPDj04/dOLlm08EDcQJDqaGQg==", + "dev": true, + "dependencies": { + "@babel/parser": "^7.20.15", + "@jsdoc/salty": "^0.2.1", + "@types/markdown-it": "^12.2.3", + "bluebird": "^3.7.2", + "catharsis": "^0.9.0", + "escape-string-regexp": "^2.0.0", + "js2xmlparser": "^4.0.2", + "klaw": "^3.0.0", + "markdown-it": "^12.3.2", + "markdown-it-anchor": "^8.4.1", + "marked": "^4.0.10", + "mkdirp": "^1.0.4", + "requizzle": "^0.2.3", + "strip-json-comments": "^3.1.0", + "underscore": "~1.13.2" + }, + "bin": { + "jsdoc": "jsdoc.js" + }, + "engines": { + "node": ">=12.0.0" + } + }, + "node_modules/jsdoc-api": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/jsdoc-api/-/jsdoc-api-8.0.0.tgz", + "integrity": "sha512-Rnhor0suB1Ds1abjmFkFfKeD+kSMRN9oHMTMZoJVUrmtCGDwXty+sWMA9sa4xbe4UyxuPjhC7tavZ40mDKK6QQ==", + "dev": true, + "dependencies": { + "array-back": "^6.2.2", + "cache-point": "^2.0.0", + "collect-all": "^1.0.4", + "file-set": "^4.0.2", + "fs-then-native": "^2.0.0", + "jsdoc": "^4.0.0", + "object-to-spawn-args": "^2.0.1", + "temp-path": "^1.0.0", + "walk-back": "^5.1.0" + }, + "engines": { + "node": ">=12.17" + } + }, + "node_modules/jsdoc-parse": { + "version": "6.2.0", + "resolved": "https://registry.npmjs.org/jsdoc-parse/-/jsdoc-parse-6.2.0.tgz", + "integrity": "sha512-Afu1fQBEb7QHt6QWX/6eUWvYHJofB90Fjx7FuJYF7mnG9z5BkAIpms1wsnvYLytfmqpEENHs/fax9p8gvMj7dw==", + "dev": true, + "dependencies": { + "array-back": "^6.2.2", + "lodash.omit": "^4.5.0", + "lodash.pick": "^4.4.0", + "reduce-extract": "^1.0.0", + "sort-array": "^4.1.5", + "test-value": "^3.0.0" + }, + "engines": { + "node": ">=12" + } + }, + "node_modules/jsdoc-to-markdown": { + "version": "8.0.0", + "resolved": "https://registry.npmjs.org/jsdoc-to-markdown/-/jsdoc-to-markdown-8.0.0.tgz", + "integrity": "sha512-2FQvYkg491+FP6s15eFlgSSWs69CvQrpbABGYBtvAvGWy/lWo8IKKToarT283w59rQFrpcjHl3YdhHCa3l7gXg==", + "dev": true, + "dependencies": { + "array-back": "^6.2.2", + "command-line-tool": "^0.8.0", + "config-master": "^3.1.0", + "dmd": "^6.2.0", + "jsdoc-api": "^8.0.0", + "jsdoc-parse": "^6.2.0", + "walk-back": "^5.1.0" + }, + "bin": { + "jsdoc2md": "bin/cli.js" + }, + "engines": { + "node": ">=12.17" + } + }, + "node_modules/jsdoc/node_modules/escape-string-regexp": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-2.0.0.tgz", + "integrity": "sha512-UpzcLCXolUWcNu5HtVMHYdXJjArjsF9C0aNnquZYY4uW/Vu0miy5YoWvbV345HauVvcAUnpRuhMMcqTcGOY2+w==", + "dev": true, + "engines": { + "node": ">=8" + } + }, "node_modules/jsesc": { "version": "2.5.2", "resolved": "https://registry.npmjs.org/jsesc/-/jsesc-2.5.2.tgz", @@ -3532,6 +3964,15 @@ "node": ">=0.10.0" } }, + "node_modules/klaw": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/klaw/-/klaw-3.0.0.tgz", + "integrity": "sha512-0Fo5oir+O9jnXu5EefYbVK+mHMBeEVEy2cmctR1O1NECcCkPRreJKrS6Qt/j3KC2C148Dfo9i3pCmCMsdqGr0g==", + "dev": true, + "dependencies": { + "graceful-fs": "^4.1.9" + } + }, "node_modules/levn": { "version": "0.4.1", "resolved": "https://registry.npmjs.org/levn/-/levn-0.4.1.tgz", @@ -3551,6 +3992,15 @@ "integrity": "sha512-7ylylesZQ/PV29jhEDl3Ufjo6ZX7gCqJr5F7PKrqc93v7fzSymt1BpwEU8nAUXs8qzzvqhbjhK5QZg6Mt/HkBg==", "dev": true }, + "node_modules/linkify-it": { + "version": "3.0.3", + "resolved": "https://registry.npmjs.org/linkify-it/-/linkify-it-3.0.3.tgz", + "integrity": "sha512-ynTsyrFSdE5oZ/O9GEf00kPngmOfVwazR5GKDq6EYfhlpFug3J2zybX56a2PRRpc9P+FuSoGNAwjlbDs9jJBPQ==", + "dev": true, + "dependencies": { + "uc.micro": "^1.0.1" + } + }, "node_modules/load-json-file": { "version": "4.0.0", "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-4.0.0.tgz", @@ -3605,6 +4055,12 @@ "integrity": "sha512-v2kDEe57lecTulaDIuNTPy3Ry4gLGJ6Z1O3vE1krgXZNrsQ+LFTGHVxVjcXPs17LhbZVGedAJv8XZ1tvj5FvSg==", "dev": true }, + "node_modules/lodash.camelcase": { + "version": "4.3.0", + "resolved": "https://registry.npmjs.org/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz", + "integrity": "sha512-TwuEnCnxbc3rAvhf/LbG7tJUDzhqXyFnv3dtzLOPgCG/hODL7WFnsbwktkD7yUV0RrreP/l1PALq/YSg6VvjlA==", + "dev": true + }, "node_modules/lodash.flattendeep": { "version": "4.4.0", "resolved": "https://registry.npmjs.org/lodash.flattendeep/-/lodash.flattendeep-4.4.0.tgz", @@ -3623,6 +4079,24 @@ "integrity": "sha512-0KpjqXRVvrYyCsX1swR/XTK0va6VQkQM6MNo7PqW77ByjAhoARA8EfrP1N4+KlKj8YS0ZUCtRT/YUuhyYDujIQ==", "dev": true }, + "node_modules/lodash.omit": { + "version": "4.5.0", + "resolved": "https://registry.npmjs.org/lodash.omit/-/lodash.omit-4.5.0.tgz", + "integrity": "sha512-XeqSp49hNGmlkj2EJlfrQFIzQ6lXdNro9sddtQzcJY8QaoC2GO0DT7xaIokHeyM+mIT0mPMlPvkYzg2xCuHdZg==", + "dev": true + }, + "node_modules/lodash.padend": { + "version": "4.6.1", + "resolved": "https://registry.npmjs.org/lodash.padend/-/lodash.padend-4.6.1.tgz", + "integrity": "sha512-sOQs2aqGpbl27tmCS1QNZA09Uqp01ZzWfDUoD+xzTii0E7dSQfRKcRetFwa+uXaxaqL+TKm7CgD2JdKP7aZBSw==", + "dev": true + }, + "node_modules/lodash.pick": { + "version": "4.4.0", + "resolved": "https://registry.npmjs.org/lodash.pick/-/lodash.pick-4.4.0.tgz", + "integrity": "sha512-hXt6Ul/5yWjfklSGvLQl8vM//l3FtyHZeuelpzK6mm99pNvN9yTDruNZPEJZD1oWrqo+izBmB7oUfWgcCX7s4Q==", + "dev": true + }, "node_modules/log-symbols": { "version": "4.1.0", "resolved": "https://registry.npmjs.org/log-symbols/-/log-symbols-4.1.0.tgz", @@ -3705,6 +4179,32 @@ "url": "https://github.com/sponsors/sindresorhus" } }, + "node_modules/markdown-it": { + "version": "12.3.2", + "resolved": "https://registry.npmjs.org/markdown-it/-/markdown-it-12.3.2.tgz", + "integrity": "sha512-TchMembfxfNVpHkbtriWltGWc+m3xszaRD0CZup7GFFhzIgQqxIfn3eGj1yZpfuflzPvfkt611B2Q/Bsk1YnGg==", + "dev": true, + "dependencies": { + "argparse": "^2.0.1", + "entities": "~2.1.0", + "linkify-it": "^3.0.1", + "mdurl": "^1.0.1", + "uc.micro": "^1.0.5" + }, + "bin": { + "markdown-it": "bin/markdown-it.js" + } + }, + "node_modules/markdown-it-anchor": { + "version": "8.6.7", + "resolved": "https://registry.npmjs.org/markdown-it-anchor/-/markdown-it-anchor-8.6.7.tgz", + "integrity": "sha512-FlCHFwNnutLgVTflOYHPW2pPcl2AACqVzExlkGQNsi4CJgqOHN7YTgDd4LuhgN1BFO3TS0vLAruV1Td6dwWPJA==", + "dev": true, + "peerDependencies": { + "@types/markdown-it": "*", + "markdown-it": "*" + } + }, "node_modules/marked": { "version": "4.3.0", "resolved": "https://registry.npmjs.org/marked/-/marked-4.3.0.tgz", @@ -3717,6 +4217,12 @@ "node": ">= 12" } }, + "node_modules/mdurl": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/mdurl/-/mdurl-1.0.1.tgz", + "integrity": "sha512-/sKlQJCBYVY9Ers9hqzKou4H6V5UWc/M59TH2dvkt+84itfnq7uFOMLpOiOS4ujvHP4etln18fmIxA5R5fll0g==", + "dev": true + }, "node_modules/meow": { "version": "8.1.2", "resolved": "https://registry.npmjs.org/meow/-/meow-8.1.2.tgz", @@ -3967,6 +4473,24 @@ "node": ">= 6" } }, + "node_modules/mkdirp": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-1.0.4.tgz", + "integrity": "sha512-vVqVZQyf3WLx2Shd0qJ9xuvqgAyKPLAiqITEtqW0oIUjzo3PePDd6fW9iFz30ef7Ysp/oiWqbhszeGWW2T6Gzw==", + "dev": true, + "bin": { + "mkdirp": "bin/cmd.js" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/mkdirp2": { + "version": "1.0.5", + "resolved": "https://registry.npmjs.org/mkdirp2/-/mkdirp2-1.0.5.tgz", + "integrity": "sha512-xOE9xbICroUDmG1ye2h4bZ8WBie9EGmACaco8K8cx6RlkJJrxGIqjGqztAI+NMhexXBcdGbSEzI6N3EJPevxZw==", + "dev": true + }, "node_modules/mocha": { "version": "10.2.0", "resolved": "https://registry.npmjs.org/mocha/-/mocha-10.2.0.tgz", @@ -4306,6 +4830,21 @@ "node": ">=6" } }, + "node_modules/object-get": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/object-get/-/object-get-2.1.1.tgz", + "integrity": "sha512-7n4IpLMzGGcLEMiQKsNR7vCe+N5E9LORFrtNUVy4sO3dj9a3HedZCxEL2T7QuLhcHN1NBuBsMOKaOsAYI9IIvg==", + "dev": true + }, + "node_modules/object-to-spawn-args": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/object-to-spawn-args/-/object-to-spawn-args-2.0.1.tgz", + "integrity": "sha512-6FuKFQ39cOID+BMZ3QaphcC8Y4cw6LXBLyIgPU+OhIYwviJamPAn+4mITapnSBQrejB+NNp+FMskhD8Cq+Ys3w==", + "dev": true, + "engines": { + "node": ">=8.0.0" + } + }, "node_modules/once": { "version": "1.4.0", "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", @@ -4830,6 +5369,98 @@ "node": ">=8" } }, + "node_modules/reduce-extract": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/reduce-extract/-/reduce-extract-1.0.0.tgz", + "integrity": "sha512-QF8vjWx3wnRSL5uFMyCjDeDc5EBMiryoT9tz94VvgjKfzecHAVnqmXAwQDcr7X4JmLc2cjkjFGCVzhMqDjgR9g==", + "dev": true, + "dependencies": { + "test-value": "^1.0.1" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/reduce-extract/node_modules/array-back": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", + "integrity": "sha512-1WxbZvrmyhkNoeYcizokbmh5oiOCIfyvGtcqbK3Ls1v1fKcquzxnQSceOx6tzq7jmai2kFLWIpGND2cLhH6TPw==", + "dev": true, + "dependencies": { + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/reduce-extract/node_modules/test-value": { + "version": "1.1.0", + "resolved": "https://registry.npmjs.org/test-value/-/test-value-1.1.0.tgz", + "integrity": "sha512-wrsbRo7qP+2Je8x8DsK8ovCGyxe3sYfQwOraIY/09A2gFXU9DYKiTF14W4ki/01AEh56kMzAmlj9CaHGDDUBJA==", + "dev": true, + "dependencies": { + "array-back": "^1.0.2", + "typical": "^2.4.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/reduce-flatten": { + "version": "3.0.1", + "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-3.0.1.tgz", + "integrity": "sha512-bYo+97BmUUOzg09XwfkwALt4PQH1M5L0wzKerBt6WLm3Fhdd43mMS89HiT1B9pJIqko/6lWx3OnV4J9f2Kqp5Q==", + "dev": true, + "engines": { + "node": ">=8" + } + }, + "node_modules/reduce-unique": { + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/reduce-unique/-/reduce-unique-2.0.1.tgz", + "integrity": "sha512-x4jH/8L1eyZGR785WY+ePtyMNhycl1N2XOLxhCbzZFaqF4AXjLzqSxa2UHgJ2ZVR/HHyPOvl1L7xRnW8ye5MdA==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/reduce-without": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/reduce-without/-/reduce-without-1.0.1.tgz", + "integrity": "sha512-zQv5y/cf85sxvdrKPlfcRzlDn/OqKFThNimYmsS3flmkioKvkUGn2Qg9cJVoQiEvdxFGLE0MQER/9fZ9sUqdxg==", + "dev": true, + "dependencies": { + "test-value": "^2.0.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/reduce-without/node_modules/array-back": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", + "integrity": "sha512-1WxbZvrmyhkNoeYcizokbmh5oiOCIfyvGtcqbK3Ls1v1fKcquzxnQSceOx6tzq7jmai2kFLWIpGND2cLhH6TPw==", + "dev": true, + "dependencies": { + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/reduce-without/node_modules/test-value": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/test-value/-/test-value-2.1.0.tgz", + "integrity": "sha512-+1epbAxtKeXttkGFMTX9H42oqzOTufR1ceCF+GYA5aOmvaPq9wd4PUS8329fn2RRLGNeUkgRLnVpycjx8DsO2w==", + "dev": true, + "dependencies": { + "array-back": "^1.0.3", + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/release-zalgo": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/release-zalgo/-/release-zalgo-1.0.0.tgz", @@ -4857,6 +5488,15 @@ "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", "dev": true }, + "node_modules/requizzle": { + "version": "0.2.4", + "resolved": "https://registry.npmjs.org/requizzle/-/requizzle-0.2.4.tgz", + "integrity": "sha512-JRrFk1D4OQ4SqovXOgdav+K8EAhSB/LJZqCz8tbX0KObcdeM15Ss59ozWMBWmmINMagCwmqn4ZNryUGpBsl6Jw==", + "dev": true, + "dependencies": { + "lodash": "^4.17.21" + } + }, "node_modules/resolve": { "version": "1.19.0", "resolved": "https://registry.npmjs.org/resolve/-/resolve-1.19.0.tgz", @@ -5043,6 +5683,37 @@ "node": ">=8" } }, + "node_modules/sort-array": { + "version": "4.1.5", + "resolved": "https://registry.npmjs.org/sort-array/-/sort-array-4.1.5.tgz", + "integrity": "sha512-Ya4peoS1fgFN42RN1REk2FgdNOeLIEMKFGJvs7VTP3OklF8+kl2SkpVliZ4tk/PurWsrWRsdNdU+tgyOBkB9sA==", + "dev": true, + "dependencies": { + "array-back": "^5.0.0", + "typical": "^6.0.1" + }, + "engines": { + "node": ">=10" + } + }, + "node_modules/sort-array/node_modules/array-back": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-5.0.0.tgz", + "integrity": "sha512-kgVWwJReZWmVuWOQKEOohXKJX+nD02JAZ54D1RRWlv8L0NebauKAaFxACKzB74RTclt1+WNz5KHaLRDAPZbDEw==", + "dev": true, + "engines": { + "node": ">=10" + } + }, + "node_modules/sort-array/node_modules/typical": { + "version": "6.0.1", + "resolved": "https://registry.npmjs.org/typical/-/typical-6.0.1.tgz", + "integrity": "sha512-+g3NEp7fJLe9DPa1TArHm9QAA7YciZmWnfAqEaFrBihQ7epOv9i99rjtgb6Iz0wh3WuQDjsCTDfgRoGnmHN81A==", + "dev": true, + "engines": { + "node": ">=10" + } + }, "node_modules/source-map": { "version": "0.6.1", "resolved": "https://registry.npmjs.org/source-map/-/source-map-0.6.1.tgz", @@ -5227,6 +5898,39 @@ "node": ">=4" } }, + "node_modules/stream-connect": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/stream-connect/-/stream-connect-1.0.2.tgz", + "integrity": "sha512-68Kl+79cE0RGKemKkhxTSg8+6AGrqBt+cbZAXevg2iJ6Y3zX4JhA/sZeGzLpxW9cXhmqAcE7KnJCisUmIUfnFQ==", + "dev": true, + "dependencies": { + "array-back": "^1.0.2" + }, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/stream-connect/node_modules/array-back": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz", + "integrity": "sha512-1WxbZvrmyhkNoeYcizokbmh5oiOCIfyvGtcqbK3Ls1v1fKcquzxnQSceOx6tzq7jmai2kFLWIpGND2cLhH6TPw==", + "dev": true, + "dependencies": { + "typical": "^2.6.0" + }, + "engines": { + "node": ">=0.12.0" + } + }, + "node_modules/stream-via": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/stream-via/-/stream-via-1.0.4.tgz", + "integrity": "sha512-DBp0lSvX5G9KGRDTkR/R+a29H+Wk2xItOF+MpZLLNDWbEV9tGPnqLPxHEYjmiz8xGtJHRIqmI+hCjmNzqoA4nQ==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/string_decoder": { "version": "1.3.0", "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.3.0.tgz", @@ -5314,6 +6018,40 @@ "node": ">=8" } }, + "node_modules/table-layout": { + "version": "0.4.5", + "resolved": "https://registry.npmjs.org/table-layout/-/table-layout-0.4.5.tgz", + "integrity": "sha512-zTvf0mcggrGeTe/2jJ6ECkJHAQPIYEwDoqsiqBjI24mvRmQbInK5jq33fyypaCBxX08hMkfmdOqj6haT33EqWw==", + "dev": true, + "dependencies": { + "array-back": "^2.0.0", + "deep-extend": "~0.6.0", + "lodash.padend": "^4.6.1", + "typical": "^2.6.1", + "wordwrapjs": "^3.0.0" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/table-layout/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, + "dependencies": { + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/temp-path": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/temp-path/-/temp-path-1.0.0.tgz", + "integrity": "sha512-TvmyH7kC6ZVTYkqCODjJIbgvu0FKiwQpZ4D1aknE7xpcDf/qEOB8KZEK5ef2pfbVoiBhNWs3yx4y+ESMtNYmlg==", + "dev": true + }, "node_modules/test-exclude": { "version": "6.0.0", "resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-6.0.0.tgz", @@ -5328,6 +6066,31 @@ "node": ">=8" } }, + "node_modules/test-value": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/test-value/-/test-value-3.0.0.tgz", + "integrity": "sha512-sVACdAWcZkSU9x7AOmJo5TqE+GyNJknHaHsMrR6ZnhjVlVN9Yx6FjHrsKZ3BjIpPCT68zYesPWkakrNupwfOTQ==", + "dev": true, + "dependencies": { + "array-back": "^2.0.0", + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/test-value/node_modules/array-back": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz", + "integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==", + "dev": true, + "dependencies": { + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4" + } + }, "node_modules/text-extensions": { "version": "1.9.0", "resolved": "https://registry.npmjs.org/text-extensions/-/text-extensions-1.9.0.tgz", @@ -5563,6 +6326,18 @@ "node": ">=14.17" } }, + "node_modules/typical": { + "version": "2.6.1", + "resolved": "https://registry.npmjs.org/typical/-/typical-2.6.1.tgz", + "integrity": "sha512-ofhi8kjIje6npGozTip9Fr8iecmYfEbS06i0JnIg+rh51KakryWF4+jX8lLKZVhy6N+ID45WYSFCxPOdTWCzNg==", + "dev": true + }, + "node_modules/uc.micro": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/uc.micro/-/uc.micro-1.0.6.tgz", + "integrity": "sha512-8Y75pvTYkLJW2hWQHXxoqRgV7qb9B+9vFEtidML+7koHUFapnVJAZ6cKs+Qjz5Aw3aZWHMC6u0wJE3At+nSGwA==", + "dev": true + }, "node_modules/uglify-js": { "version": "3.17.4", "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.17.4.tgz", @@ -5576,6 +6351,12 @@ "node": ">=0.8.0" } }, + "node_modules/underscore": { + "version": "1.13.6", + "resolved": "https://registry.npmjs.org/underscore/-/underscore-1.13.6.tgz", + "integrity": "sha512-+A5Sja4HP1M08MaXya7p5LvjuM7K6q/2EaC0+iovj/wOcMsTzMvDFbasi/oSapiwOlt252IqsKqPjCl7huKS0A==", + "dev": true + }, "node_modules/undici-types": { "version": "5.26.5", "resolved": "https://registry.npmjs.org/undici-types/-/undici-types-5.26.5.tgz", @@ -5676,6 +6457,15 @@ "integrity": "sha512-AFbieoL7a5LMqcnOF04ji+rpXadgOXnZsxQr//r83kLPr7biP7am3g9zbaZIaBGwBRWeSvoMD4mgPdX3e4NWBg==", "dev": true }, + "node_modules/walk-back": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/walk-back/-/walk-back-5.1.0.tgz", + "integrity": "sha512-Uhxps5yZcVNbLEAnb+xaEEMdgTXl9qAQDzKYejG2AZ7qPwRQ81lozY9ECDbjLPNWm7YsO1IK5rsP1KoQzXAcGA==", + "dev": true, + "engines": { + "node": ">=12.17" + } + }, "node_modules/which": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/which/-/which-2.0.2.tgz", @@ -5703,6 +6493,28 @@ "integrity": "sha512-gvVzJFlPycKc5dZN4yPkP8w7Dc37BtP1yczEneOb4uq34pXZcvrtRTmWV8W+Ume+XCxKgbjM+nevkyFPMybd4Q==", "dev": true }, + "node_modules/wordwrapjs": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/wordwrapjs/-/wordwrapjs-3.0.0.tgz", + "integrity": "sha512-mO8XtqyPvykVCsrwj5MlOVWvSnCdT+C+QVbm6blradR7JExAhbkZ7hZ9A+9NUtwzSqrlUo9a67ws0EiILrvRpw==", + "dev": true, + "dependencies": { + "reduce-flatten": "^1.0.1", + "typical": "^2.6.1" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/wordwrapjs/node_modules/reduce-flatten": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-1.0.1.tgz", + "integrity": "sha512-j5WfFJfc9CoXv/WbwVLHq74i/hdTUpy+iNC534LxczMRP67vJeK3V9JOdnL0N1cIRbn9mYhE2yVjvvKXDxvNXQ==", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, "node_modules/workerpool": { "version": "6.2.1", "resolved": "https://registry.npmjs.org/workerpool/-/workerpool-6.2.1.tgz", @@ -5744,6 +6556,12 @@ "typedarray-to-buffer": "^3.1.5" } }, + "node_modules/xmlcreate": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/xmlcreate/-/xmlcreate-2.0.4.tgz", + "integrity": "sha512-nquOebG4sngPmGPICTS5EnxqhKbCmz5Ox5hsszI2T6U5qdrJizBc+0ilYSEjTSzU0yZcmvppztXe/5Al5fUwdg==", + "dev": true + }, "node_modules/xtend": { "version": "4.0.2", "resolved": "https://registry.npmjs.org/xtend/-/xtend-4.0.2.tgz", diff --git a/package.json b/package.json index c547e16..24437ac 100644 --- a/package.json +++ b/package.json @@ -21,6 +21,8 @@ ], "scripts": { "docs": "npx typedoc --out docs src && cp LICENSE.md docs/LICENSE.md && cp CHANGELOG.md docs/CHANGELOG.md", + "docs:md": "npm run build && rm -rf DOCUMENTATION.md && ./node_modules/.bin/jsdoc2md -f 'dist/**/*.js' > DOCUMENTATION.md", + "gen-readme": "npm run build && rm README.md && node scripts/gen_readme.js", "test": "NODE_PATH=./src NODE_ENV=test mocha", "test:coverage": "NODE_PATH=./src NODE_ENV=test nyc mocha", "test:watch": "NODE_PATH=./src NODE_ENV=test nyc mocha --watch", @@ -29,7 +31,7 @@ "update-deps": "updates -u -g -c", "update-version": "standard-version -a", "prepare": "husky install", - "prepare-release": "npm run lint && npm run test && npm run build && npm run docs && git add docs", + "prepare-release": "npm run lint && npm run test && npm run build && npm run docs && git add docs && npm run docs:md && npm run gen-readme", "prepublish": "npm run build", "release": "npm run prepare-release && npm run update-version && git push --follow-tags origin main" }, @@ -48,6 +50,7 @@ "eslint": "^8.56.0", "eslint-plugin-tsdoc": "^0.2.17", "husky": "^8.0.3", + "jsdoc-to-markdown": "^8.0.0", "mocha": "^10.2.0", "nyc": "^15.1.0", "standard-version": "^9.5.0", diff --git a/scripts/gen_readme.js b/scripts/gen_readme.js new file mode 100644 index 0000000..641ad08 --- /dev/null +++ b/scripts/gen_readme.js @@ -0,0 +1,30 @@ +const path = require('path') +const { promises: fs } = require('fs') +const _template = require('lodash/template') +const jsDoc2MD = require('jsdoc-to-markdown') + +/** + * @private + */ +const getPath = (p) => path.join(__dirname, '../', p) + +const TEMPLATE_SRC = '.README.md' +const TEMPLATE_DST = 'README.md' +const API_SRC = ['dist/**'].map(getPath) + +jsDoc2MD + .render({ files: API_SRC }) + .then(async (api) => { + const templatePath = getPath(TEMPLATE_SRC) + const templateSrc = await fs.readFile(templatePath, 'utf-8') + const template = _template(templateSrc) + const readme = template({ api }) + const dst = getPath(TEMPLATE_DST) + + await fs.writeFile(dst, readme) + + console.log(`rendered ${dst}`) + }) + .catch((e) => { + console.error(e.stack) + }) diff --git a/src/index.ts b/src/index.ts index 21f6740..bd31adf 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,12 +1,4 @@ import parse from './parse' import { InvalidInputError } from './errors' -/** - * A tiny utility library _with no dependencies_ that parses natural language - * dates, times, and intervals to either a `Date` instance or a numerical value - * in milliseconds. - * - * @packageDocumentation - */ - export { InvalidInputError, parse } diff --git a/src/parse.ts b/src/parse.ts index 5eec10d..a8a554c 100644 --- a/src/parse.ts +++ b/src/parse.ts @@ -4,6 +4,14 @@ import * as U from './utils' import * as E from './errors' import { TimeUnit, TimeUnitPlural } from './types' +/** + * A tiny utility library _with no dependencies_ that parses natural language + * dates, times, and intervals to either a `Date` instance or a numerical value + * in milliseconds. + * + * @packageDocumentation + */ + /** * Parses a string into a `Date` or number of milliseconds. The string can * describe the date in natural language (e.g. "tomorrow", "in 2 hours and 3