Skip to content

add Step.id to typings, fix tour.getById() typing #1044

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.

Sign up for GitHub

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

Merged
RobbieTheWagner merged 1 commit into from
Jul 13, 2020
Merged

add Step.id to typings, fix tour.getById() typing #1044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/types/step.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,11 @@ declare class Step extends Evented {
* @return The newly created Step instance
*/
constructor(tour: Tour, options: Step.StepOptions);//TODO superheri Note: Return on constructor is not possible in typescript. Could this be possible to make this the same for the constructor of the Step class?

/**
* The string used as the `id` for the step.
*/
id: string;

/**
* Cancel the tour
Expand Down
4 changes: 2 additions & 2 deletions src/types/tour.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,9 +45,9 @@ declare class Tour extends Evented {
/**
* Gets the step from a given id
* @param id The id of the step to retrieve
* @return The step corresponding to the `id`
* @return The step corresponding to the `id` or null if no step matches the `id`
*/
getById(id: number | string): Step;
getById(id: number | string): Step | null;

/**
* Gets the current step
Expand Down