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

Fix types for dragAndDrop command in new Elem API. #4329

Merged
merged 3 commits into from
Dec 18, 2024

Conversation

ShreySinha02
Copy link
Contributor

@ShreySinha02 ShreySinha02 commented Dec 15, 2024

Thanks in advance for your contribution. Please follow the below steps in submitting a pull request, as it will help us with reviewing it quicker.

  • Before marking your PR for review, please test and verify your changes by making appropriate modifications to any of the Nightwatch example tests (present in examples/tests directory of the project) and running them. ecosia.js and duckDuckGo.js are good examples to work with.
  • Create a new branch from master (e.g. features/my-new-feature or issue/123-my-bugfix);
  • If you're fixing a bug also create an issue if one doesn't exist yet;
  • If it's a new feature explain why do you think it's necessary. Please check with the maintainers beforehand to make sure it is something that we will accept. Usually we only accept new features if we feel that they will benefit the entire community;
  • Please avoid sending PRs which contain drastic or low level changes. If you are certain that the changes are needed, please discuss them beforehand and indicate what the impact will be;
  • If your change is based on existing functionality please consider refactoring first. Pull requests that duplicate code will most likely be ignored;
  • Do not include changes that are not related to the issue at hand;
  • Follow the same coding style with regards to spaces, semicolons, variable naming etc.;
  • Always add unit tests - PRs without tests are most of the times ignored.

@CLAassistant
Copy link

CLAassistant commented Dec 15, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Member

@garg3133 garg3133 left a comment

Choose a reason for hiding this comment

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

It'd also be great if you could add some tests for the types modified here.

Comment on lines 366 to 369
};
}
|{readonly x: number; readonly y: number;}
|WebElement
Copy link
Member

Choose a reason for hiding this comment

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

@ShreySinha02 You're on the right track here but we do not need to include both the coordinates and WebElement here. You can add | WebElement directly in the type definition of dragAndDrop(). And perhaps change the above type to DragAndDropDestinationCoordinates?

@ShreySinha02
Copy link
Contributor Author

@garg3133 made the changes and added the test please look into this

Comment on lines 363 to 365
export type DragAndDropDestination =
|{readonly x: number; readonly y: number;}
|WebElement
Copy link
Contributor

Choose a reason for hiding this comment

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

minor lint fixes (proper spaces), otherwise LGTM!

export type DragAndDropDestination = 
  | {readonly x: number; readonly y: number;}
  | WebElement

@garg3133

Copy link
Member

@garg3133 garg3133 left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks, @ShreySinha02!

@garg3133 garg3133 linked an issue Dec 18, 2024 that may be closed by this pull request
@garg3133 garg3133 changed the title fix issue #4238 Typescript types for dragAndDrop are incorrect Fix types for dragAndDrop command in new Elem API. Dec 18, 2024
@garg3133 garg3133 merged commit 715a751 into nightwatchjs:main Dec 18, 2024
17 checks passed
@garg3133 garg3133 mentioned this pull request Dec 18, 2024
9 tasks
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.

Typescript types for dragAndDrop are incorrect
4 participants