Skip to content

Fix: Update docs and Readme package description #28

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

Open
vijayprakashpj wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix: Update docs and Readme package description #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0373b17
Fix: Update FS package description
vijayprakashpj Aug 16, 2022
b450824
Fix: Map correct return and error types
vijayprakashpj Aug 16, 2022
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,4 @@ For more complex use cases checkout the [website](https://qio.netlify.com).
| **@qio/stream** | Purely functional streaming capabilities built on top of QIO. | ![npm](https://img.shields.io/npm/v/@qio/stream.svg) |
| **@qio/console** | QIO based bindings to read and write to the terminal. | ![npm](https://img.shields.io/npm/v/@qio/console.svg) |
| **@qio/http** | QIO based binding to manage HTTP request/responses safely. | ![npm](https://img.shields.io/npm/v/@qio/http.svg) |
| **@qio/fs** | QIO based binding to manage HTTP request/responses safely. | ![npm](https://img.shields.io/npm/v/@qio/fs.svg) |
| **@qio/fs** | QIO based binding to interact with the file system safely. | ![npm](https://img.shields.io/npm/v/@qio/fs.svg) |
2 changes: 1 addition & 1 deletion packages/docs/core/usage.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ const greet = () => console.log('Hello World!') // void
```ts
import {QIO} from '@qio/core'

const greetIO = QIO.lift(greet) // QIO<never, void, unknown>
const greetIO = QIO.lift(greet) // QIO<void, never, unknown>
```

| Parameter | Value | |
Expand Down