feat(ses): Expand TypeScript coverage for Compartment and lockdown #584
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
|
I'll review this when tests pass. Feel free to ping me when ready. |
kriskowal
force-pushed
the
ses-tsc
branch
2 times, most recently
from
8962de7
to
95406c8
Compare
michaelfig
approved these changes
Feb 27, 2021
packages/ses/src/error/assert.js
Outdated
| // without breaking the meaning of the type. As currently written, if it is | ||
| // moved into a separate @callback type, it no longer understands that `args` | ||
| // is a rest parameter. I have not yet figured out how to declare that it is, | ||
| // except by having it here directly annotating the `details` function. |
There was a problem hiding this comment.
I have mixed feelings about @callback.
I'd recommend moving it to types.js and declaring it as something like:
/** @typedef {(template: TemplateStringsArray, ...args: Array<any>) => ...} DetailsTag */There was a problem hiding this comment.
Oh, this is diff churn. @erights added the DetailsTag type to types.js already and this is a holdover from before I rebased.
I’m removing this text. Though, for posterity, I think that @callback is useful in JSDoc over what appears in types.js because it produces an opportunity to describe each parameter with prose to go with the type and name. I look forward to using jsdoc for docs too!
Comment on lines
+7
to
+8
| // @ts-check | ||
|
|
There was a problem hiding this comment.
Duplicate.
Suggested change
| // @ts-check |
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.
This change includes Compartment and lockdown in the SES shim’s exported types and generally extends the reach of TypeScript verification into SES sources. This change uses the expedient of reexporting the return types of functions that are checked by
yarn tsc:lintwhich may not be sufficient. In a subsequent change, it will likely be necessary to convert the Compartment and lockdown types into interface definitions that are imported by the sources and also exported byindex.d.ts.