orion/purescript-cbor-stream
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix: readme

Browse Source
This commit is contained in:
orion 2024-05-22 15:50:30 -05:00
parent 5363e3d76a
commit c331c63d1d
Signed by: orion
GPG Key ID: 6D4165AE4C928719
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -7,3 +7,22 @@ Type-safe bindings for the streaming API of `cbor-x`
spago install cbor-stream
{bun|yarn|npm|pnpm} install cbor-x
```
## Examples
### Convert a cbor-encoded dataset to csv
```purescript
import Pipes.Node.Stream as Pipes.Stream
import Pipes.Node.FS as Pipes.FS
import Pipes.Node.Buffer as Pipes.Buffer
import Pipes.CBOR as Pipes.CBOR
import Pipes.CSV as Pipes.CSV
import Pipes.Prelude ((>->))
import Pipes.Prelude as Pipes
Pipes.runEffect
$ Pipes.FS.read "foo.bin"
>-> Pipes.CBOR.decode @{id :: Int, name :: String}
>-> Pipes.CSV.stringify
>-> Pipes.FS.write "foo.csv"
```