From 1e3f8fb92cb1a2c75307d81cf90c535fa26706d0 Mon Sep 17 00:00:00 2001 From: Cris Mihalache Date: Thu, 21 Dec 2023 20:00:17 +0100 Subject: [PATCH] chore: update docs --- docs/assets/search.js | 2 +- docs/classes/InvalidInputError.html | 14 +++++++------- docs/functions/parse.html | 4 ++-- docs/index.html | 2 +- docs/modules.html | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/assets/search.js b/docs/assets/search.js index 05bedf5..7ccd488 100644 --- a/docs/assets/search.js +++ b/docs/assets/search.js @@ -1 +1 @@ -window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6WUzY6bMBSF3+V0eyfB5qet913kBbqxUIXAo7FKDLKddCTEu48gAx4UI2Wmyzjfd8+Rfxhgu38OQg74q00DwfgPgqnOCgInc61a3ZxMf/G/rO0sCBfbQqBuK+eUO94Rhxd/bkELAAGMtMzOGV9n151x3l5q//DUb1vlQwKhr6wyPlo5xLOEZ2v+Hz0hj0avdEj1rnnS7qm3+lp59bUOjfKVbh8useL/24IXnGWhx+dqRFp8MfdTR3B/Ao+mFiGxr6xTa+LzxdRed8Yd5/XY3S0J2jTqFWLAVVmnOwMBfkgPP0F41qptptdzm0+ou/N5KlS+//dbTbd1Im7IMQHJhFhx+J6VJclFmNfnhZliIMkiFNtQHCR5hOIbKgXJNEKlGyoDySxCZRsqB8k8QuUbqgDJIkIVMzXv6FVZr5rTbWelDC9hmB7mvJouhzYghRjGMezu9GsavLzKIPEg8R1p8xUJJgsm2zHvO2ZBynaku4p5cPJdZ77Ms6pu393gJ8FPdvz3Wx6cIjhFzCkJve5Vq42CkOU4vgGSCSPQFwYAAA=="; \ No newline at end of file +window.searchData = "data:application/octet-stream;base64,H4sIAAAAAAAAA6VY2W7jNhT9F/ahfWA13Be/92F+oC9GUGhsJRZqS4YkJ9MG+feCm60rhTZnCgTQDaVzl3MXkn5HQ/82os32Hf3ddnu0ocxg1NWnBm3Q1+61Prb7r935Mv0xDP2AMLoMR7RBu2M9js34ZfVFdZhOR4TTB2iD0AdOuiVlV927vhun4bKbirX+AiEzCxid66Hppk9dvpmnhImr/b9a90mp6evXN6vTuP+9HX8/D+1rPTU/58O+mer2WOzE9fP/6wVTjIqbHz/mxide/KTdH0rBOgOlVtXN4rkexuZq8fnS7aa278Yvfv2z2n3CqO32zXe0eUevzTC2fYc2iFW8sgij57Y57l33BP0Y7frTyTn0FN/92bhqdV+ET74QhLcEm4op/fSEtwng1ymmFbUas/jkmFaaMSwwqYhSWGJSMSqwiusak0oyiY17WoYtppXiFFPiFEiLadJIk0qadFKRVmQSklqqoz5q0isbVxhJLtL4sfs+CEkzE0mQSVAJnjSz6LKnwPNCEd4yi6mqtADEUE8YqYzAPhoT+KCERT6o54Eb6uN370P8wsbYTAzJhIAU1dEjI6NHTjBR4A6sCcWcJoElgSdBJCEZ4Cqt6LRikmDjK0GS/0mzYCEwwcObGx0M4a0Qn9DhX7h6sNLHz4kOdSCFrwMjQ7aMxMLzTw0WKgg39dxp0Z+o51f1gSNDVODICyYKwscmDRYWs4oLiSVJAk2CY00xiyUPKzfrwtW6xrLSEloXV+s2FKhj01m3JlaR0ib44wUTBc8114FPqyOhbsHEBRm1SceJ1QxLlQSdBJMEGwXlEsbUjDeJ8FZiVhGtgOMyOk6JCVkRJmSFaJ8VrW1IixN8XqSWIS9O8N45wVukDCvHYhoR3rJCeKvYJxlTsT8EdsFLxcO4MNw7QkloD2qod4Q5R9znVokwHrhM40Hz4KP7hpGojPtwBXOFHdWT+LFnWwSOhcs3qSzjLgZSGS6w4k6gWIn4dHFzZrBSSdDxjYlPG19oEha081AZgzVLAk+CSIJMgkqCTkLUq214mqjWOHqplNiwuMCjYSOSIOOb5KvRSTBJSN5akoSk10a9NlJgk1qbOLBJr40c2OirDb4+Pfmd57UZpmb/NexA2y1C+N2dXPy/XKZt7f3jtvNs3hENK8o9Pj5csRA6BxqaAQLERMjG/1WEkH/neKsf49kcoAsMMkINcJI8xnBgRDwGXE9QN5i4BYO4/3IOjrB49pihbsYQy6DqOYDmwiFhZZ2z+lsPbbJcvskMtNs152kEllUB7KUHVBYkuO4AHyaD4GFFrMPr9sAkLzA5NKBCCrz8BhA5AMwBCw+5cnkHY2YPUgqRXQ+SWZAUf90BfVfQRuCONPPV3uqVZup111+OICciV3BzhiJ2aPz1YzadcuzQG2q/wNBcgGtG9/U/gJqC8tk3425oYUXwXEms+zHAz+6+MNcgcz7zOXQ5dehs6ohVPhYFKZaaGpAmmWN67sFlqJee0xxnsxpsqhdQtfYxzc3pPIHcyBxoFlcTfl2YOVfQqhE67UCP5ybR3MXv9el8hMOkJLLvbrguWDQFldd8Px/rtms7QKbMtdeMl+dVtlkuPlgzfFU6Lw0YJjK3XYpVc7+0rw2Imeews7QcmsW0zk28GU+H/jKAvUuzx6D2GcysHGLeS6CvW7iR3R1bC+DueNnD7PBcGdE57rkfTqt2ZDlSyRy6OIfcSigm7Gf2tbYbp7rbwcF4l8eEm8CxQRWcwNrwOw2ojFwfrGE+/tWsuKUscvUwca/9zvMPis0WnDhbgDAlAYN80btJBv16rLuXS/0CsqIKhtupGccFTOSm6SyZp/Z4bMdm13d7EKMq6NtT212mBnZuQVJPfTcdAKjEVg/nCivYxbp6ugw12IBVweGxa95ASxSw2IGGkLl4xBwBLxY5yPrM1V1O3xrQCKqA9B6MS5lrc77qmt5vfZBFkRt3fI07gkMBvXuZARv84mCQ83h9RuyH9qVdeKxySZwRe66H+tRMkFtasu9e8SNs25vP0b/16duDfvsVXNRtwfYXccvrsy1opQgF91RbUEIRBzdOWzALPRDO/vukZrcsrwnOqYJzmEMtDmGs7E64Pk6d68XlrOAAeR7613YPx9fdcgYweDfLhbu+MwT4Im6eq49ZHQ9NPS4uOzmrfI6aLgNE5bI8c3LsT/C4WLDTjdOwiErltnCRK6TpUMMNOpfGRxU5HeCW+yM/NcAfST7TvTh3FMyF6TD0YPuyBYx6EDyVFk9beBZ8QCOd4079sPBVFxzFLotRwu5eGQNmdfbUBV37VgPyZW5izKr57bC4MD127e0A9kd29weiO3PprT2CDY/n0r4eFG8tPI7xuzPm48P9RH1uz82x7Rq02T59fPwHkWYrTk4gAAA="; \ No newline at end of file diff --git a/docs/classes/InvalidInputError.html b/docs/classes/InvalidInputError.html index 8b7eef4..cca757e 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 b11eea0..6564f97 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 b5dcfe2..fbd7d5b 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -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 diff --git a/docs/modules.html b/docs/modules.html index 3fe1cf6..b5266c4 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