Skip to content

ship intercompat type declaraions#292

Merged
jkowalleck merged 4 commits intomainfrom
intercompat-typedefs
Oct 25, 2022
Merged

ship intercompat type declaraions#292
jkowalleck merged 4 commits intomainfrom
intercompat-typedefs

Conversation

@jkowalleck
Copy link
Member

@jkowalleck jkowalleck commented Oct 24, 2022

fixes #291

have type declarations that work with TS v3.8, and above

down to which version of typescript should the type-declaration inter-compatibility reach?
TS 3.8 it is the latest version of the previous major version. According to TS' version policy v4 would be a breaking change, so v3 users could upgrade their projects to v3.8 without problems and therefore have full access to type declarations of this very project.

background:
TS 3.8 appears to be the lowest typescript version i could get support for out of the box.
I might go below, by the use of https://github.com/sandersn/downlevel-dts(untested).


  • render dedicated typedefs
  • apply type defs, instead of sources
  • have a CI example to test the compatibility with 3.8, and 4.X

@jkowalleck jkowalleck added the enhancement New feature or request label Oct 24, 2022
@jkowalleck jkowalleck force-pushed the intercompat-typedefs branch 2 times, most recently from e467fcc to d967c64 Compare October 24, 2022 09:20
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck force-pushed the intercompat-typedefs branch 2 times, most recently from b328f76 to 35eb4e3 Compare October 24, 2022 22:19
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck force-pushed the intercompat-typedefs branch 4 times, most recently from 4d2a8ca to 265a2a4 Compare October 24, 2022 22:41
@jkowalleck jkowalleck marked this pull request as ready for review October 24, 2022 22:43
@jkowalleck jkowalleck requested a review from a team as a code owner October 24, 2022 22:43
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck force-pushed the intercompat-typedefs branch from 265a2a4 to 5ff854a Compare October 24, 2022 23:01
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
@jkowalleck jkowalleck changed the title ship intercompat typedefs ship intercompat type declaraions Oct 25, 2022
@jkowalleck jkowalleck merged commit 773b925 into main Oct 25, 2022
@jkowalleck jkowalleck deleted the intercompat-typedefs branch October 25, 2022 07:07
@jkowalleck jkowalleck mentioned this pull request Jan 29, 2023
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Render inter-compatible type-definition files

1 participant