Skip to content

Commit cc1dadf

Browse files
committed
docs(zod-test): fixes typo and a few broken links in the README (#550)
1 parent c91ebab commit cc1dadf

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

.changeset/ten-rabbits-care.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@traversable/zod-test": patch
3+
---
4+
5+
docs(zod-test): fixes typo and a few broken links in the README (#550)

packages/zod-test/README.md

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -75,15 +75,15 @@ import { zxTest } from '@traversable/zod-test'
7575

7676
## Table of contents
7777

78-
- [`zxTest.fuzz`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxfuzz)
78+
- [`zxTest.fuzz`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxtestfuzz)
7979
- [`zxTest.seedToSchema`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxtestseedtoschema)
8080
- [`zxTest.seedToValidData`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxtestseedtovaliddata)
8181
- [`zxTest.seedToInvalidData`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxtestseedtoinvaliddata)
82-
- [`zxTest.seedToValidDataGenerator`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxseedtovaliddatagenerator)
83-
- [`zxTest.seedToInvalidDataGenerator`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxseedtoinvaliddatagenerator)
82+
- [`zxTest.seedToValidDataGenerator`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxtestseedtovaliddatagenerator)
83+
- [`zxTest.seedToInvalidDataGenerator`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxtestseedtoinvaliddatagenerator)
8484
- [`zxTest.SeedGenerator`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxtestseedgenerator)
85-
- [`zxTest.SeedValidDataGenerator`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxseedvaliddatagenerator)
86-
- [`zxTest.SeedInvalidDataGenerator`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxseedinvaliddatagenerator)
85+
- [`zxTest.SeedValidDataGenerator`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxtestseedvaliddatagenerator)
86+
- [`zxTest.SeedInvalidDataGenerator`](https://github.com/traversable/schema/tree/main/packages/zod-test#zxtestseedinvaliddatagenerator)
8787

8888

8989
### `zxTest.fuzz`
@@ -97,22 +97,23 @@ Override individual arbitraries via the 3rd argument (`overrides`).
9797
> [!NOTE]
9898
>
9999
> `zxTest.fuzz` is the __only__ schema-to-generator function that has itself
100-
> been fuzz tested to ensure that no matter what schema you give it, the data-generator that `fuzz`
101-
> returns will always produce valid data.
102-
103-
The only known exceptions are schemas that make it impossible to generate valid data. For example:
104-
105-
- `z.never`
106-
- `z.nonoptional(z.undefined())`
107-
- `z.enum([])`
108-
- `z.union([])`
109-
- `z.intersection(z.number(), z.string())`
100+
> been fuzz tested to ensure that no matter what schema you give it, the data-generator it
101+
> returns will always produce valid data.
102+
>
103+
> This excludes schemas that make it impossible to generate valid data, for example:
104+
>
105+
> - `z.never`
106+
> - `z.nonoptional(z.undefined())`
107+
> - `z.enum([])`
108+
> - `z.union([])`
109+
> - `z.intersection(z.number(), z.string())`
110110
111111
#### Example
112112

113113
```typescript
114114
import * as vi from 'vitest'
115-
import * as fc from 'fast-check' * import { fuzz } from '@traversable/zod-test'
115+
import * as fc from 'fast-check'
116+
import { fuzz } from '@traversable/zod-test'
116117

117118
const Schema = z.record(
118119
z.string(),

0 commit comments

Comments
 (0)