Repository navigation
fix(typings): add a result type to StepPromise, fix grab return types - #5808
Open
danielrentz wants to merge 2 commits into
Open
danielrentz wants to merge 2 commits into
danielrentz wants to merge 2 commits into
Conversation
StepPromise and ElementStepPromise extended Promise<any>, so a helper step that returns data could not be declared with its result type, and declaration merging cannot add a type parameter. The default keeps every existing CodeceptJS.StepPromise as it is. Refs codeceptjs#5806
The JSDoc of several grab methods declared void, any, a plain array or StepPromise, so awaiting them failed type-aware linting and a missing await went unnoticed. WebDriver's grabBrowserLogs() always returns an array, like the other helpers. Refs codeceptjs#5806
This branch has not been deployed
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.
Motivation/Description of the PR
StepPromiseandElementStepPromiseget a result type parameter,anyby default, so a helper step that returns data can be declared asCodeceptJS.StepPromise<string>. Existing uses keep their type.grabDataFromPerformanceTiming(),grabStorageState(),grabCookie(),grabRecordedNetworkTraffics(),grabBrowserLogs()(WebDriver) andgrabTrafficUrl(), with the CDPBrowser variants. Typings: StepPromise has no result type, and several grab methods have wrong return types #5806 lists the old and new types.grabWebSocketMessages(),grabFileNames()) keep their types.grabElementBoundingRect()keeps its union, since its two result types would need overloads that tsd-jsdoc does not generate.npm run defandnpm run dtslintpass. Without the type parameter, the new tsd tests fail.Applicable helpers:
Applicable plugins:
Type of change
Checklist:
npm run docs)npm run lint)npm test)