Skip to content

Commit 74c4e7f

Browse files
committed
docs(README): copy/paste typos
1 parent 64cfeaa commit 74c4e7f

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -90,22 +90,22 @@ Maybe.tryFirst(employees)
9090
```
9191

9292
1. `tryFirst` finds the first employee in the array and wraps it in a `Maybe`. If the array is empty, a `Maybe` with no value is returned.
93-
1. `tap`'s callback is only called if an employee was found and logs out that employees' information.
93+
1. `tap`'s callback is only called if an employee was found and logs out that employee's information.
9494
1. `bind`'s callback is only called if an employee was found and converts the `Maybe` wrapping it into to another `Maybe`.
9595
1. `from` wraps the employee's manager in a `Maybe`. If the employee has no manager, a `Maybe` with no value is returned.
9696
1. `or` supplies a fallback in the case that the employee has no manager so that as long as an employee was originally found, all the following operations will execute.
9797
1. `map` converts the manager to a new object which contains both the manager and employee.
9898
1. `match` executes its `some` function if an employee was originally found and that employee has a manager. Since we supplied a fallback manager with `or`, the `some` function of `match` will execute if we found an employee. The `none` function of `match` executes if we didn't find any employees.
9999

100-
See more examples of Maybe [in the docs](./docs/maybe.md) or [in the tests](./test/maybe).
100+
See more examples of `Maybe` [in the docs](./docs/maybe.md) or [in the tests](./test/maybe).
101101

102102
### MaybeAsync
103103

104104
`MaybeAsync` represents a future value (`Promise`) that might or might not exist.
105105

106106
`MaybeAsync` works just like `Maybe`, but since it is asynchronous, its methods accept a `Promise<T>` in most cases and all of its value accessing methods/getters return a `Promise<T>`.
107107

108-
See more examples of Maybe [in the docs](./docs/maybeAsync.md) or [in the tests](./test/maybeAsync).
108+
See more examples of `MaybeAsync` [in the docs](./docs/maybeAsync.md) or [in the tests](./test/maybeAsync).
109109

110110
### Result
111111

@@ -171,7 +171,7 @@ Result.try(
171171
1. `map`'s callback is only called if the original employee was found, has a `managerId` and that manager was also found. It converts the manager returned by `try` to a new object capturing both the manager and employee's name.
172172
1. `match`'s `success` callback is only called if all the required information was retrieved and sends a reminder to the employee's manager. The `failure` callback is called if any of the required data could not be retrieved and sends an alert to the business supervisor with the error message.
173173

174-
See more examples of Maybe [in the docs](./docs/result.md) or [in the tests](./test/result).
174+
See more examples of `Result` [in the docs](./docs/result.md) or [in the tests](./test/result).
175175

176176
### ResultAsync
177177

@@ -198,4 +198,4 @@ const result = await resultAsync.toPromise();
198198
console.log(result.getErrorOrThrow()); // 'Could not retrieve inventory: connection failure'
199199
```
200200

201-
See more examples of Maybe [in the docs](./docs/resultAsync.md) or [in the tests](./test/resultAsync).
201+
See more examples of `ResultAsync` [in the docs](./docs/resultAsync.md) or [in the tests](./test/resultAsync).

0 commit comments

Comments
 (0)