Skip to content
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

Node: Fix issues with type import & exports #767

Merged
merged 5 commits into from
Jan 16, 2024

Conversation

shachlanAmazon
Copy link
Contributor

Issue #, if available:

Description of changes:
Some types that should be user-facing weren't exported in the index.ts file.
Some types that shouldn't be user-facing were exported, for use in tests.
Protobuf types, which don't have good Typescript definitions, were exported to the user.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

This saves us declaring each type that should be exported. This is done
because multiple types haven't been exported, and so would've been
harder for our users to use.
This is done so that we won't expose Protobuf types externally, since
Protobuf doesn't create good Typescript bindings.
It's exported for testing, not for the user.
Importing types from files and not the index helped hide the fact that
these types weren't exported.
This will remove non user-facing types from the release.
@shachlanAmazon shachlanAmazon merged commit d1f6a2d into valkey-io:main Jan 16, 2024
6 checks passed
@shachlanAmazon shachlanAmazon deleted the node-types branch January 16, 2024 09:59
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.

3 participants