Tagged helper for StartFunction #9315
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dckc
approved these changes
May 2, 2024
| @@ -0,0 +1,155 @@ | |||
| /** @file adapted from https://raw.githubusercontent.com/sindresorhus/type-fest/main/source/opaque.d.ts */ | |||
There was a problem hiding this comment.
What's the license? ah. CC0 Public Domain Dedication. very well.
might be worth noting that.
| // because TS is structural, without this the generic is ignored | ||
| [StartFunction]: SF; | ||
| }; | ||
| export type Installation<SF extends ContractStartFunction | unknown> = Tagged< |
There was a problem hiding this comment.
I'm not sure how to read this. X | unknown is unknown for any X, isn't it?
There was a problem hiding this comment.
this used to be SF which was any. I constrained it to SF extends ContractStartFunction but some places explicitly pass unknown. So this continues to allow that.
| @@ -13,22 +14,24 @@ type ContractFacet<T extends {} = {}> = { | |||
| /** | |||
| * Installation of a contract, typed by its start function. | |||
| */ | |||
| declare const StartFunction: unique symbol; | |||
There was a problem hiding this comment.
ok, so no more unique symbol... though we take on responsibility for any collisions for strings such as StartFunction.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
refs: #9283
Description
#9283 was failing integration with,
I've been meaning to adopt the
Taggedhelper from types-fest so I took this opportunity to try it and it solved this problem. So this PR adds it to@agoric/internaland uses it for theInstallationandInstancetypes that need a tag. It doesn't use if for the three otherdeclare constwe have in the repo.While debugging I also noticed we could cut a few ambient runtime imports so I did that. One required moving ManualTimer type into its impl module.
Security Considerations
I vendored the file instead of importing from NPM to not take the external dep
Scaling Considerations
n/a, types
Documentation Considerations
should not be developer-facing
Testing Considerations
CI
Upgrade Considerations
n/a, types