Skip to content

Commit

Permalink
fix api links
Browse files Browse the repository at this point in the history
  • Loading branch information
fubhy committed Dec 27, 2023
1 parent c2eb3e0 commit cae173f
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 17 deletions.
2 changes: 1 addition & 1 deletion pages/docs/batching-caching.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -248,4 +248,4 @@ Let's see how we would go about using cache:
that implement the [`Equal`](./trait/equal.mdx) interface.
</Warning>

There are many more methods available in the `Cache` module. As a next step, check out the [reference docs](https://effect-ts.github.io/effect/modules/Cache.ts.html)!
There are many more methods available in the `Cache` module. As a next step, check out the [reference docs](https://effect-ts.github.io/effect/effect/Cache.ts.html)!
2 changes: 1 addition & 1 deletion pages/docs/error-management/error-channel-operations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ In addition to the filtering capabilities discussed earlier, you have the option

In the example above, a guard is used within the `filterOrFail` API to ensure that the `user` is of type `User` rather than `User | null`. This refined type information improves the reliability of your code and makes it more understandable.

If you prefer, you can utilize a pre-made guard like [`Predicate.isNotNull`](https://effect-ts.github.io/effect/modules/Predicate.ts.html#isnotnull) for simplicity and consistency.
If you prefer, you can utilize a pre-made guard like [`Predicate.isNotNull`](https://effect-ts.github.io/effect/effect/Predicate.ts.html#isnotnull) for simplicity and consistency.

## Inspecting Errors

Expand Down
2 changes: 1 addition & 1 deletion pages/docs/essentials/creating.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -222,7 +222,7 @@ The table provides a summary of the available constructors, along with their inp
| `async` | `(Effect<never, E, A> => void) => void` | `Effect<never, E, A>` |
| `suspend` | `() => Effect<R, E, A>` | `Effect<R, E, A>` |

You can find the complete list of constructors [here](https://effect-ts.github.io/io/modules/Effect.ts.html#constructors).
You can find the complete list of constructors [here](https://effect-ts.github.io/effect/effect/Effect.ts.html#constructors).

Now that we know how to create effects, it's time to learn how to run them.
Check out the next guide on [Running Effects](running.mdx) to find out more.
2 changes: 1 addition & 1 deletion pages/docs/essentials/running.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -83,4 +83,4 @@ The table provides a summary of the available `run*` functions, along with their
| `runPromise` | `Effect<never, E, A>` | `Promise<A>` |
| `runPromiseExit` | `Effect<never, E, A>` | `Promise<Exit<E, A>>` |

You can find the complete list of `run*` functions [here](https://effect-ts.github.io/io/modules/Effect.ts.html#execution).
You can find the complete list of `run*` functions [here](https://effect-ts.github.io/effect/effect/Effect.ts.html#execution).
25 changes: 15 additions & 10 deletions pages/docs/packages/_meta.json
Original file line number Diff line number Diff line change
@@ -1,32 +1,37 @@
{
"effect": {
"title": "effect ↗",
"href": "https://effect-ts.github.io/effect/docs/modules",
"href": "https://effect-ts.github.io/effect/docs/effect",
"newWindow": true
},
"@effect/cli": {
"title": "@effect/cli ↗",
"href": "https://effect-ts.github.io/cli/docs/modules",
"newWindow": true
},
"@effect/match": {
"title": "@effect/match ↗",
"href": "https://effect-ts.github.io/match/docs/modules",
"href": "https://effect-ts.github.io/effect/docs/cli",
"newWindow": true
},
"@effect/opentelemetry": {
"title": "@effect/opentelemetry ↗",
"href": "https://effect-ts.github.io/opentelemetry/docs/modules",
"href": "https://effect-ts.github.io/effect/docs/opentelemetry",
"newWindow": true
},
"@effect/rpc": {
"title": "@effect/rpc ↗",
"href": "https://effect-ts.github.io/effect/docs/rpc",
"newWindow": true
},
"@effect/platform": {
"title": "@effect/platform ↗",
"href": "https://effect-ts.github.io/platform/docs/platform",
"href": "https://effect-ts.github.io/effect/docs/platform",
"newWindow": true
},
"@effect/printer": {
"title": "@effect/printer ↗",
"href": "https://effect-ts.github.io/printer/",
"href": "https://effect-ts.github.io/effect/docs/printer",
"newWindow": true
},
"@effect/typeclass": {
"title": "@effect/typeclass ↗",
"href": "https://effect-ts.github.io/effect/docs/typeclass",
"newWindow": true
},
"schema": "@effect/schema"
Expand Down
4 changes: 2 additions & 2 deletions pages/docs/packages/schema/_meta.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"get-started": {
"title": "Getting Started ↗",
"href": "https://github.com/Effect-TS/schema#introduction",
"href": "https://github.com/Effect-TS/effect/blob/main/packages/schema/README.md#introduction",
"newWindow": true
},
"reference": {
"title": "API Reference ↗",
"href": "https://effect-ts.github.io/schema/docs/modules",
"href": "https://effect-ts.github.io/effect/docs/schema",
"newWindow": true
}
}
2 changes: 1 addition & 1 deletion pages/docs/trait/equal.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ JavaScript's built-in `Set` and `Map` can be a bit tricky when it comes to check

Even though the two elements in the set have the same values, the set contains two elements. Why? JavaScript's `Set` checks for equality by reference, not by values.

To perform value-based equality checks, you'll need to use the `Hash*` collection types available in the `effect` package. These collection types, such as [`HashSet`](https://effect-ts.github.io/data/modules/HashSet.ts.html) and [`HashMap`](https://effect-ts.github.io/data/modules/HashMap.ts.html), provide support for the `Equal` trait.
To perform value-based equality checks, you'll need to use the `Hash*` collection types available in the `effect` package. These collection types, such as [`HashSet`](https://effect-ts.github.io/effect/effect/HashSet.ts.html) and [`HashMap`](https://effect-ts.github.io/effect/effect/HashMap.ts.html), provide support for the `Equal` trait.

Let's take a closer look at how to use `HashSet` for value-based equality checks:

Expand Down

0 comments on commit cae173f

Please sign in to comment.