Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates API documentation to better reflect actual thrown errors in verifier and client methods, and regenerates the published HTML docs accordingly.
Changes:
- Clarifies
AVVerifier.submitVerifierKeyto document that failures currently surface as raw Axios errors (not wrapped inNetworkError). - Refines
AVClient.extendVoterSessionsdocumentation around the pre-registration failure mode. - Updates the generated TypeDoc HTML pages to match the updated JSDoc.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| lib/av_verifier.ts | Updates @throws documentation for submitVerifierKey. |
| lib/av_client.ts | Updates @throws documentation for extendVoterSessions. |
| docs/classes/av_verifier.AVVerifier.html | Regenerated docs reflecting the updated AVVerifier throws text. |
| docs/classes/av_client.AVClient.html | Regenerated docs reflecting the updated AVClient throws text. |
Comments suppressed due to low confidence (1)
lib/av_client.ts:629
extendVoterSessionscurrently throws a runtimeTypeErrorwhen called before registration because it dereferencesthis.voterSessionwithout checking for it. Since this is a public API and other methods useInvalidStateErrorfor precondition violations, it would be more consistent (and safer for consumers) to explicitly guard and throwInvalidStateErrorinstead of leaking aTypeError.
* @throws TypeError if called before voter registration (`this.voterSession` is undefined — the method dereferences it directly without a null check).
* @throws {@link NetworkError | NetworkError} if any request failed to get a response.
*/
public async extendVoterSessions(extendedBy: number): Promise<void> {
if (!this.voterSession.address) return;
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or 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
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.
No description provided.