Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
21 changes: 19 additions & 2 deletions docs/en/v1/api/clean/primitives/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,12 +147,29 @@ Checks whether a `Date` is after a threshold.
### [dateLessThan](/en/v1/api/clean/primitives/operators/dateLessThan)
Checks whether a `Date` is before a threshold.

### [dateAddTime](/en/v1/api/clean/primitives/operators/dateAddTime)
Adds a duration to a `Date`.

### [dateSubtractTime](/en/v1/api/clean/primitives/operators/dateSubtractTime)
Subtracts a duration from a `Date`.

### [dateMin](/en/v1/api/clean/primitives/operators/dateMin)
Returns the smallest date in a list.

### [dateMax](/en/v1/api/clean/primitives/operators/dateMax)
Returns the largest date in a list.

### [sort](/en/v1/api/clean/primitives/operators/sort)
Sorts an array of primitives (`String`, `Number`, or `Date`) in `"ASC"` / `"DSC"`.
### [timeGreaterThan](/en/v1/api/clean/primitives/operators/timeGreaterThan)
Checks whether a `Time` is strictly greater than a threshold.

### [timeLessThan](/en/v1/api/clean/primitives/operators/timeLessThan)
Checks whether a `Time` is strictly less than a threshold.

### [timeMin](/en/v1/api/clean/primitives/operators/timeMin)
Returns the smallest duration in a list.

### [timeMax](/en/v1/api/clean/primitives/operators/timeMax)
Returns the largest duration in a list.

### [sort](/en/v1/api/clean/primitives/operators/sort)
Sorts an array of primitives (`String`, `Number`, `Date`, or `Time`) in `"ASC"` / `"DSC"`.
54 changes: 54 additions & 0 deletions docs/en/v1/api/clean/primitives/operators/dateAddTime.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
outline: [2, 3]
prev:
text: "dateLessThan"
link: "/en/v1/api/clean/primitives/operators/dateLessThan"
next:
text: "dateSubtractTime"
link: "/en/v1/api/clean/primitives/operators/dateSubtractTime"
---

# dateAddTime

`dateAddTime()` adds a duration to a wrapped `Date`. The duration can be a wrapped `Time` or a `DDate.TheTime`. Supports the curried version.

## Interactive example

<MonacoTSEditor
src="/examples/v1/api/clean/primitives/operators/dateAddTime/tryout.doc.ts"
majorVersion="v1"
height="340px"
/>

## Syntax

### Classic signature

```typescript
function dateAddTime(
primitive: Date,
time: Time | TheTime
): Date
```

### Curried signature

```typescript
function dateAddTime(
time: Time | TheTime
): (primitive: Date) => Date
```

## Parameters

- `primitive`: wrapped `Date` (classic signature only).
- `time`: duration to add.

## Return value

A wrapped `Date` with the duration added.

## See also

- [`dateSubtractTime`](/en/v1/api/clean/primitives/operators/dateSubtractTime)
- [`dateMin`](/en/v1/api/clean/primitives/operators/dateMin)
4 changes: 2 additions & 2 deletions docs/en/v1/api/clean/primitives/operators/dateLessThan.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ prev:
text: "dateGreaterThan"
link: "/en/v1/api/clean/primitives/operators/dateGreaterThan"
next:
text: "dateMin"
link: "/en/v1/api/clean/primitives/operators/dateMin"
text: "dateAddTime"
link: "/en/v1/api/clean/primitives/operators/dateAddTime"
---

# dateLessThan
Expand Down
19 changes: 5 additions & 14 deletions docs/en/v1/api/clean/primitives/operators/dateMax.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ prev:
text: "dateMin"
link: "/en/v1/api/clean/primitives/operators/dateMin"
next:
text: "sort"
link: "/en/v1/api/clean/primitives/operators/sort"
text: "timeGreaterThan"
link: "/en/v1/api/clean/primitives/operators/timeGreaterThan"
---

# dateMax

`dateMax()` returns the largest date in a list (wrapped or `DDate.TheDate`). It can be used in a variadic version or a partially applied version.
`dateMax()` returns the largest date in a list (wrapped or `DDate.TheDate`).

## Interactive example

Expand All @@ -22,24 +22,15 @@ next:

## Syntax

### Classic signature (variadic)
### Classic signature

```typescript
function dateMax(...input: AnyTuple<Date | TheDate>): Date
```

### Partial signature

```typescript
function dateMax(
first: Date | TheDate
): (...rest: (Date | TheDate)[]) => Date
function dateMax(input: AnyTuple<Date | TheDate>): Date
```

## Parameters

- `input` : dates to compare (at least one).
- `first` / `rest` : partial version (`dateMax(first)(...rest)`).

## Return value

Expand Down
15 changes: 3 additions & 12 deletions docs/en/v1/api/clean/primitives/operators/dateMin.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ next:

# dateMin

`dateMin()` returns the smallest date in a list (wrapped or `DDate.TheDate`). It can be used in a variadic version or a partially applied version.
`dateMin()` returns the smallest date in a list (wrapped or `DDate.TheDate`).

## Interactive example

Expand All @@ -22,24 +22,15 @@ next:

## Syntax

### Classic signature (variadic)
### Classic signature

```typescript
function dateMin(...input: AnyTuple<Date | TheDate>): Date
```

### Partial signature

```typescript
function dateMin(
first: Date | TheDate
): (...rest: (Date | TheDate)[]) => Date
function dateMin(input: AnyTuple<Date | TheDate>): Date
```

## Parameters

- `input` : dates to compare (at least one).
- `first` / `rest` : partial version (`dateMin(first)(...rest)`).

## Return value

Expand Down
54 changes: 54 additions & 0 deletions docs/en/v1/api/clean/primitives/operators/dateSubtractTime.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
outline: [2, 3]
prev:
text: "dateAddTime"
link: "/en/v1/api/clean/primitives/operators/dateAddTime"
next:
text: "dateMin"
link: "/en/v1/api/clean/primitives/operators/dateMin"
---

# dateSubtractTime

`dateSubtractTime()` subtracts a duration from a wrapped `Date`. The duration can be a wrapped `Time` or a `DDate.TheTime`. Supports the curried version.

## Interactive example

<MonacoTSEditor
src="/examples/v1/api/clean/primitives/operators/dateSubtractTime/tryout.doc.ts"
majorVersion="v1"
height="340px"
/>

## Syntax

### Classic signature

```typescript
function dateSubtractTime(
primitive: Date,
time: Time | TheTime
): Date
```

### Curried signature

```typescript
function dateSubtractTime(
time: Time | TheTime
): (primitive: Date) => Date
```

## Parameters

- `primitive`: wrapped `Date` (classic signature only).
- `time`: duration to subtract.

## Return value

A wrapped `Date` with the duration subtracted.

## See also

- [`dateAddTime`](/en/v1/api/clean/primitives/operators/dateAddTime)
- [`dateMax`](/en/v1/api/clean/primitives/operators/dateMax)
10 changes: 5 additions & 5 deletions docs/en/v1/api/clean/primitives/operators/sort.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
outline: [2, 3]
prev:
text: "dateMax"
link: "/en/v1/api/clean/primitives/operators/dateMax"
text: "timeMax"
link: "/en/v1/api/clean/primitives/operators/timeMax"
next:
text: "Clean"
link: "/en/v1/api/clean/"
---

# sort

`sort()` sorts an array of wrapped primitives (`String`, `Number`, `Date`) in "ASC" or "DSC". Supports the curried version to integrate easily in a pipeline.
`sort()` sorts an array of wrapped primitives (`String`, `Number`, `Date`, `Time`) in "ASC" or "DSC". Supports the curried version to integrate easily in a pipeline.

## Interactive example

Expand All @@ -26,7 +26,7 @@ next:

```typescript
function sort(
input: readonly (String | Number | Date | string | number | TheDate)[],
input: readonly (String | Number | Date | Time | string | number | TheDate | TheTime)[],
type: SortType
): any[]
```
Expand All @@ -37,7 +37,7 @@ function sort(
function sort(
type: SortType
): (
input: readonly (String | Number | Date | string | number | TheDate)[]
input: readonly (String | Number | Date | Time | string | number | TheDate | TheTime)[]
) => any[]
```

Expand Down
54 changes: 54 additions & 0 deletions docs/en/v1/api/clean/primitives/operators/timeGreaterThan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
outline: [2, 3]
prev:
text: "dateMax"
link: "/en/v1/api/clean/primitives/operators/dateMax"
next:
text: "timeLessThan"
link: "/en/v1/api/clean/primitives/operators/timeLessThan"
---

# timeGreaterThan

`timeGreaterThan()` checks whether a wrapped `Time` is strictly greater than a threshold (wrapped `Time` or `DDate.TheTime`). Supports the curried version.

## Interactive example

<MonacoTSEditor
src="/examples/v1/api/clean/primitives/operators/timeGreaterThan/tryout.doc.ts"
majorVersion="v1"
height="340px"
/>

## Syntax

### Classic signature

```typescript
function timeGreaterThan(
primitive: Time,
threshold: Time | TheTime
): boolean
```

### Curried signature

```typescript
function timeGreaterThan(
threshold: Time | TheTime
): (primitive: Time) => boolean
```

## Parameters

- `primitive`: wrapped `Time` (classic signature only).
- `threshold`: comparison threshold.

## Return value

`true` if `primitive > threshold`, otherwise `false`.

## See also

- [`timeLessThan`](/en/v1/api/clean/primitives/operators/timeLessThan)
- [`timeMin`](/en/v1/api/clean/primitives/operators/timeMin)
54 changes: 54 additions & 0 deletions docs/en/v1/api/clean/primitives/operators/timeLessThan.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
outline: [2, 3]
prev:
text: "timeGreaterThan"
link: "/en/v1/api/clean/primitives/operators/timeGreaterThan"
next:
text: "timeMin"
link: "/en/v1/api/clean/primitives/operators/timeMin"
---

# timeLessThan

`timeLessThan()` checks whether a wrapped `Time` is strictly less than a threshold (wrapped `Time` or `DDate.TheTime`). Supports the curried version.

## Interactive example

<MonacoTSEditor
src="/examples/v1/api/clean/primitives/operators/timeLessThan/tryout.doc.ts"
majorVersion="v1"
height="340px"
/>

## Syntax

### Classic signature

```typescript
function timeLessThan(
primitive: Time,
threshold: Time | TheTime
): boolean
```

### Curried signature

```typescript
function timeLessThan(
threshold: Time | TheTime
): (primitive: Time) => boolean
```

## Parameters

- `primitive`: wrapped `Time` (classic signature only).
- `threshold`: comparison threshold.

## Return value

`true` if `primitive < threshold`, otherwise `false`.

## See also

- [`timeGreaterThan`](/en/v1/api/clean/primitives/operators/timeGreaterThan)
- [`timeMax`](/en/v1/api/clean/primitives/operators/timeMax)
Loading
Loading