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

chore: remove usage of opaque ids types related to project ids #280

Merged
merged 1 commit into from
Sep 26, 2023

Conversation

achou11
Copy link
Member

@achou11 achou11 commented Sep 25, 2023

Towards #278

I had introduced opaque types for project id and project public id, but made the mistake of using those for the public-facing API, which makes their usage more tedious and doesn't bring any major benefit for now.

Opaque types are useful if usage is kept internally, but maybe that's something to revisit later on.

Doing this towards publishing the IPC wrapper as a separate module, which works with APIs that used to rely on these opaque types.

Copy link
Member

@gmaclennan gmaclennan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm still on the fence about opaque types - I can definitely see the appeal. But happy to remove these for now. Part of the problem is the syntax when using JSDoc.

@achou11
Copy link
Member Author

achou11 commented Sep 26, 2023

yeah hoping there's some sort of write-up about using them and the best way to utilize them for libraries.

@achou11 achou11 merged commit 5f1c4e8 into main Sep 26, 2023
6 checks passed
@achou11 achou11 deleted the ac/remove-opaque-id branch September 26, 2023 16:48
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