Skip to content

Use EventHandle; add missing API; uncurried fns #47

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.

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

Closed
wants to merge 15 commits into from

Conversation

JordanMartinez
Copy link
Contributor

@JordanMartinez JordanMartinez commented Jun 25, 2023

Description of the change

  • Added dependency on the node-event-emitter library; replaced all onEventName with eventNameH API
  • Formatted code via purs-tidy
  • Add missing event handlers for Writable/Readable
  • Add missing API for Readable/Writeable
  • Add other misc. missing API
  • Convert FFI to uncurried
  • Update read functions
  • Use consistent naming scheme: Suffix of ' represents the callback form. _ indicate returned value will be Effect Unit (as opposed to Effect Boolean).
    • NOTE: this is the one change I no longer like. My goal is naming consistency but ' should likely be replaced with cb to indicate that version is the one that exposes the callback version.
  • Update tests
  • Update module docs link to Node's v16 docs
  • Adds fromBuffer/fromString (fixes streamFromString #45)

Checklist:

  • Added the change to the changelog's "Unreleased" section with a reference to this PR (e.g. "- Made a change (#0000)")
  • Linked any existing issues or proposals that this pull request should close
  • Updated or added relevant documentation
  • Added a test for the contribution (if applicable)

@JordanMartinez JordanMartinez added the type: breaking change A change that requires a major version bump. label Jun 26, 2023
@JordanMartinez
Copy link
Contributor Author

Superceded by #48, #49, #50, and #51.

@JordanMartinez JordanMartinez deleted the depend-on-event-emitter branch July 6, 2023 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: breaking change A change that requires a major version bump.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

streamFromString
1 participant