Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: Fix link to Equivalence API #1861

Merged
merged 3 commits into from
Jan 5, 2024
Merged

README: Fix link to Equivalence API #1861

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f7dc78
README: Fix link to Equivalence API
strogonoff Jan 5, 2024
cfb6fcf
README: fix another link to Equivalence API doc
strogonoff Jan 5, 2024
3afdacf
Update README.md
fubhy Jan 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/schema/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Welcome to the documentation for `@effect/schema`, **a library for defining and
| Arbitraries | Generate arbitraries for [fast-check](https://github.com/dubzzz/fast-check) testing. |
| Pretty printing | Support pretty printing for data structures. |
| JSON Schemas | Create JSON Schemas based on defined schemas. |
| Equivalence | Create [Equivalences](https://effect-ts.github.io/effect/modules/Equivalence.ts.html) based on defined schemas. |
| Equivalence | Create [Equivalences](https://effect-ts.github.io/effect/schema/Equivalence.ts.html) based on defined schemas. |

If you're eager to learn how to define your first schema, jump straight to the [**Basic usage**](#basic-usage) section!

Expand Down Expand Up @@ -920,7 +920,7 @@ As seen in the example, the JSON Schema annotations are merged with the base JSO

## Generating Equivalences

The `to` function, which is part of the `@effect/schema/Equivalence` module, allows you to generate an [Equivalence](https://effect-ts.github.io/effect/modules/Equivalence.ts.html) based on a schema definition:
The `to` function, which is part of the `@effect/schema/Equivalence` module, allows you to generate an [Equivalence](https://effect-ts.github.io/effect/schema/Equivalence.ts.html) based on a schema definition:

```ts
import * as S from "@effect/schema/Schema";
Expand Down