Skip to content
This repository has been archived by the owner on Jan 6, 2025. It is now read-only.

Commit

Permalink
update docs (#364)
Browse files Browse the repository at this point in the history
  • Loading branch information
gcanti authored Jul 27, 2023
1 parent e2c5dee commit 49dff47
Showing 1 changed file with 60 additions and 0 deletions.
60 changes: 60 additions & 0 deletions docs/modules/Schema.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ Added in v1.0.0
- [maxItems](#maxitems)
- [minItems](#minitems)
- [bigint](#bigint)
- [BigintFromString](#bigintfromstring)
- [betweenBigint](#betweenbigint)
- [bigintFromString](#bigintfromstring)
- [clampBigint](#clampbigint)
- [greaterThanBigint](#greaterthanbigint)
- [greaterThanOrEqualToBigint](#greaterthanorequaltobigint)
Expand All @@ -48,6 +50,7 @@ Added in v1.0.0
- [attachPropertySignature](#attachpropertysignature)
- [brand](#brand)
- [chunk](#chunk)
- [compose](#compose)
- [data](#data)
- [dataFromSelf](#datafromself)
- [declare](#declare)
Expand Down Expand Up @@ -161,6 +164,7 @@ Added in v1.0.0
- [minLength](#minlength)
- [nonEmpty](#nonempty)
- [pattern](#pattern)
- [split](#split)
- [startsWith](#startswith)
- [trim](#trim)
- [trimmed](#trimmed)
Expand Down Expand Up @@ -394,6 +398,20 @@ Added in v1.0.0
# bigint
## BigintFromString
This schema transforms a `string` into a `bigint` by parsing the string using the `BigInt` function.
It returns an error if the value can't be converted (for example when non-numeric characters are provided).
**Signature**
```ts
export declare const BigintFromString: Schema<string, bigint>
```
Added in v1.0.0
## betweenBigint
**Signature**
Expand All @@ -408,6 +426,20 @@ export declare const betweenBigint: <A extends bigint>(
Added in v1.0.0
## bigintFromString
This combinator transforms a `string` into a `bigint` by parsing the string using the `BigInt` function.
It returns an error if the value can't be converted (for example when non-numeric characters are provided).
**Signature**
```ts
export declare const bigintFromString: <I, A extends string>(self: Schema<I, A>) => Schema<I, bigint>
```
Added in v1.0.0
## clampBigint
Clamps a bigint between a minimum and a maximum value.
Expand Down Expand Up @@ -635,6 +667,19 @@ export declare const chunk: <I, A>(item: Schema<I, A>) => Schema<readonly I[], C
Added in v1.0.0
## compose
**Signature**
```ts
export declare const compose: {
<B, C>(bc: Schema<B, C>): <A>(ab: Schema<A, B>) => Schema<A, C>
<A, B, C>(ab: Schema<A, B>, bc: Schema<B, C>): Schema<A, C>
}
```
Added in v1.0.0
## data
**Signature**
Expand Down Expand Up @@ -1949,6 +1994,21 @@ export declare const pattern: <A extends string>(

Added in v1.0.0

## split

This combinator allows splitting a string into an array of strings.

**Signature**

```ts
export declare const split: {
(separator: string): <I>(self: Schema<I, string>) => Schema<I, readonly string[]>
<I>(self: Schema<I, string>, separator: string): Schema<I, readonly string[]>
}
```

Added in v1.0.0

## startsWith

**Signature**
Expand Down

0 comments on commit 49dff47

Please sign in to comment.