Skip to content

Commit

Permalink
feat(semantic-release): update docs and trigger release
Browse files Browse the repository at this point in the history
  • Loading branch information
simonfan committed Feb 14, 2021
1 parent dc442cb commit 4ed0d83
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -371,11 +371,12 @@ Set of expressions aimed at solving common date-related operations:
parse, format, compare, validate, manipulate (e.g. move forward, move back).
Most (if not all) operations are based on and built with [`Luxon`](https://github.com/moment/luxon/) `DateTime`. If not stated otherwise, date operations return a `string` in ISO 8601 format (`2021-01-27T20:38:12.807Z`).

- [`DateValue`](#datevalue)
- [`DateFormat`](#dateformat)
- [`ISODate`](#isodate)
- [`Duration`](#duration)
- [`$date(parseFmtArgs, serializeFmtArgs, date)`](#dateparsefmtargs-serializefmtargs-date)
- [`$dateNow(serializeFmtArgs)`](#datenowserializefmtargs)
- [`$date(parseFmtArgs, serializeFormat, date)`](#dateparsefmtargs-serializeformat-date)
- [`$dateNow(serializeFormat)`](#datenowserializeformat)
- [`$dateIsValid()`](#dateisvalid)
- [`$dateStartOf(unitExp, date)`](#datestartofunitexp-date)
- [`$dateEndOf(unitExp, date)`](#dateendofunitexp-date)
Expand All @@ -390,6 +391,12 @@ Most (if not all) operations are based on and built with [`Luxon`](https://githu
- [`$dateMoveBackward(duration, date)`](#datemovebackwardduration-date)


##### `DateValue`

Date input for all $date expressions



##### `DateFormat`

Arguments to be forwarded to Luxon corresponding DateTime parser.
Expand Down Expand Up @@ -436,22 +443,22 @@ Duration represented in an object format:
- `seconds` {Number}
- `milliseconds` {Number}

##### `$date(parseFmtArgs, serializeFmtArgs, date)`
##### `$date(parseFmtArgs, serializeFormat, date)`

Parses a date from a given input format and serializes it into
another format. Use this expression to convert date formats into
your requirements. E.g. `UnixEpochMs` into `ISO`.

- `parseFmtArgs` {[DateFormat](#dateformat)}
- `serializeFmtArgs` {[DateFormat](#dateformat)}
- `serializeFormat` {[DateFormat](#dateformat)}
- `date` {String | Number | Object | Date}
- Returns: `date` {String | Number | Object | Date} Output will vary according to `serializeFmtArgs`
- Returns: `date` {String | Number | Object | Date} Output will vary according to `serializeFormat`

##### `$dateNow(serializeFmtArgs)`
##### `$dateNow(serializeFormat)`

Generates a ISO date string from `Date.now`

- `serializeFmtArgs` {[DateFormat](#dateformat)}
- `serializeFormat` {[DateFormat](#dateformat)}
- Returns: `date` {String | Number | Object | Date}

##### `$dateIsValid()`
Expand Down

0 comments on commit 4ed0d83

Please sign in to comment.