diff --git a/CHANGELOG.md b/CHANGELOG.md index af9180e..77e5831 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,16 @@ 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.5.1](https://github.com/f3rno64/time-speak/compare/v1.5.0...v1.5.1) (2023-12-22) + + +### Bug Fixes + +* add unstaged changes when executing standard-version ([93430e0](https://github.com/f3rno64/time-speak/commit/93430e04965b359ce59d6b975ab3783739fe366e)) +* git add docs after gen in prepare-release script ([38ece16](https://github.com/f3rno64/time-speak/commit/38ece168f86a5afcbc5650b672c54bd50ad9b8c0)) +* release script ([6ce595d](https://github.com/f3rno64/time-speak/commit/6ce595dd06106962292dc65aa68ab4abef3c9225)) +* rm npm publish from release as it is done from a github action ([092754a](https://github.com/f3rno64/time-speak/commit/092754a5dbaf30e3b0308cf8947df18908495962)) + ## [1.5.0](https://github.com/f3rno64/time-speak/compare/v1.4.1...v1.5.0) (2023-12-22) diff --git a/docs/classes/InvalidInputError.html b/docs/classes/InvalidInputError.html index 3eec83f..885965d 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 13a6b59..8f8cf88 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 18efb45..e561997 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 7fc056f..1afd630 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 029ba49..866f6d1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "time-speak", - "version": "1.5.0", + "version": "1.5.1", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "time-speak", - "version": "1.5.0", + "version": "1.5.1", "license": "MIT", "dependencies": { "tslib": "^2.6.2" diff --git a/package.json b/package.json index e5e74ab..af11f94 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "time-speak", - "version": "1.5.0", + "version": "1.5.1", "description": "A natural language parser for dates, times and intervals.", "main": "dist/index.js", "types": "dist/index.d.ts", @@ -28,9 +28,8 @@ "lint": "eslint -f unix \"src/**/*.{ts,tsx}\"", "update-deps": "updates -u -g -c", "update-version": "standard-version -a", - "prepare": "husky install", - "prepublish": "npm run build", "prepare": "npm run lint && npm run test && npm run build && npm run docs && git add docs", + "prepublish": "npm run build", "release": "npm run prepare && npm run update-version && git push --follow-tags origin main" }, "devDependencies": {