Skip to content

Adds manually written index.d.ts typescript type declaration#65

Merged
texodus merged 3 commits intofinos:masterfrom
telamonian:add-manual-index-d-ts
Jun 20, 2020
Merged

Adds manually written index.d.ts typescript type declaration#65
texodus merged 3 commits intofinos:masterfrom
telamonian:add-manual-index-d-ts

Conversation

@telamonian
Copy link
Copy Markdown
Contributor

@telamonian telamonian commented Jun 18, 2020

I've tested this PR out by yarn linking-ing it into an external typescript project. The typings seems to work well.

@texodus 9bd534d added docstrings for the RegularTableElement private methods:

  • on the genreral principle that the more (dev) docs, the better
  • I added @internal @private tags to the private docstrings. In theory, that means these private docstrings will get ignored both by jsdoc and at least one declaration generator that we can experiment with later
  • if you think these aren't appropriate, I can also just get rid of them

- this allows for inclusion of `scrollToCell` in index.d.ts typing
- previously, typescript complained that `RegularTableElemeent.scrollTo` shadowed base class `HTMLElement.scrollTo` method
@texodus
Copy link
Copy Markdown
Member

texodus commented Jun 20, 2020

Thanks for the PR! Looks good!

@texodus texodus merged commit 2401c05 into finos:master Jun 20, 2020
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.

RegularTableElement.scrollTo shadows base HTMLElement.scrollTo method

2 participants