Add type declarations #1259
Add type declarations #1259
Conversation
charlesfries
commented
Dec 8, 2022
charlesfries
commented
- Adds TypeScript ambient types
| declare module 'ember-shepherd/services/tour' { | ||
| import Shepherd from 'shepherd.js'; | ||
|
|
||
| export interface TourButton extends Shepherd.Step.StepOptionsButton { |
There was a problem hiding this comment.
This interface isn't really part of the tour service, but is needed because the default Shepard.js button type does not have a type property
index.d.ts
Outdated
| title: string; | ||
| } | ||
|
|
||
| export default interface Tour { |
There was a problem hiding this comment.
@charlesfries could we import these types from Shepherd itself?
There was a problem hiding this comment.
The Tour class type here https://github.com/shipshapecode/shepherd/blob/master/src/types/tour.d.ts seems to be pretty similar, but there are methods like addStep() that exist in the Shepherd Tour class that don't exist in the Tour Ember service.
Definitely open to figuring out how to use those types and avoid duplication, but IMO the Tour object and Tour service may need to be distinct.
There was a problem hiding this comment.
@charlesfries I'm not super experienced with TS, but I was hoping we could merge them into one. Perhaps the ember-shepherd one can extend the Shepherd ones and add more things?
