support custom stream creation

[matthewleon]

Is there any interest in supporting the creation of custom streams in this lib? I am working on a fork that does so, and wondering whether I should make a PR here, or create a separate lib.

[matthewleon]

I've created a separate repo that has some basic tools for creating custom Readable streams here: https://github.com/matthewleon/purescript-node-readable

[cprussin]

Any reason why this isn't rolled into this lib? Would you guys accept a PR to include it @paf31? I'm happy to put in a PR for it, and I'd expect this lib to provide some way to create stream values...

[cprussin]

Ping @hdgarrood and @garyb on this one. Would you guys accept a PR to directly wrap the Node new Readable(), new Writable (), and new Duplex() or do you guys not think it belongs in this lib?

[matthewleon]

@cprussin I'm happy to update my repo for PS 0.12 and then make a PR here. What do you think?

[cprussin]

@matthewleon sure, that would work; I'm just not sure if it's the kind of thing the owners of this repo want here or if they prefer it in a separate module--I'd rather let them chime in on that. I know that the intent behind purescript-node repos is to keep the APIs fairly bare bones.

[hdgarrood]

Sorry for the late response. Yes, I think a basic wrapper for those APIs would make sense here.

[matthewleon]

@cprussin I've updated https://github.com/matthewleon/purescript-node-readable for PS 0.12 support, which trimmed a lot of the fat off the library. No more nasty effect rows.

That said, it might be worth paying attention to the newtype I created for Readable streams so that I could parameterize by chunktype. This library publishes a simpler API, but I think that if you are going to be creating custom streams, you really want that parameterization to preserve type safety.

So you would either want to update purescript-node-streams to include that parameterization, or leave these as separate libs. I'm curious to see if you have an elegant solution to this, as I sadly haven't spent much time thinking about it.

[cprussin]

I ended up going a different direction with the project that I was working on that needed custom streams, so I haven't been quite so motivated to dig into this more just yet. I'm sure the need will come back to me soon though, so when I get a chance to revisit, I'll let you know what I find. Thanks for updating the lib, that will be super helpful!

[matthewleon]

Thanks for updating the lib, that will be super helpful!

No problem. It might be sensible to build yet another lib on top of it, offering a higher-level abstraction around the streams that takes care of serialization for you. I'd be curious to see the results if you do go down this path.