What to expect from the Promistreams beta phase
Promistreams are currently in their beta testing phase. What this means in practice:
- You can start using Promistreams in your projects today. But be prepared to sometimes debug issues.
- Linear pipelines will generally work perfectly. More complex pipelines may still run into small issues in edgecases.
- The stream interface has not been stabilized yet, but it is also not likely to meaningfully change anymore.
- At any given time, the latest versions of
@promistreampackages should work correctly together. - A pretty broad collection of streams is already available. Some of the most commonly useful ones are documented on this wiki, and there are more packages on npm.
- However, the stream collection is still incomplete; in particular, several splitting and merging streams are still in active development, as well adapter streams from and to different stream and sequence types.
- Documentation may still be missing for a (shrinking) subset of Promistream packages. However, a Promistream package will typically include an
example.jsthat demonstrates its use. - Bugs should, for now, be reported privately, either on Matrix (@joepie91@pixie.town) or by e-mail (admin@cryto.net). I'll walk through the issue and debug it with you personally. If you're not sure whether it's a bug, then it's a bug, just potentially a documentation bug instead of an implementation bug. Please let me know!