Skip to content

SpawnSyncOptions docs: reduce supported input types to Buffer #64

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

Merged
merged 1 commit into from
Mar 22, 2025

Conversation

Hi-Angel
Copy link
Contributor

Description of the change

input only supports Maybe Buffer and providing anything else like Maybe String will result in compilation error.

I had a problem due to this misdocumentation, where I provided a string and it ofc didn't compile. So figured would be good to have this fixed.


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)

@Hi-Angel Hi-Angel changed the title SpawnSyncOptions: reduce supported input types to string SpawnSyncOptions: reduce supported input types to Buffer Sep 30, 2024
The option only supports `Maybe Buffer` and providing anything else
like `Maybe String` will result in compilation error.
@Hi-Angel Hi-Angel changed the title SpawnSyncOptions: reduce supported input types to Buffer SpawnSyncOptions docs: reduce supported input types to Buffer Sep 30, 2024
@garyb
Copy link
Member

garyb commented Mar 22, 2025

Thanks! I'll add a changelog entry for this when I update it for the new version release.

@garyb garyb merged commit fb87bf1 into purescript-node:master Mar 22, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants