Skip to content

Switch to manual generation of DTS files #458

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

Closed
hossam-nasr opened this issue Feb 3, 2023 · 2 comments
Closed

Switch to manual generation of DTS files #458

hossam-nasr opened this issue Feb 3, 2023 · 2 comments
Assignees
Labels
breaking-change preview-blocker issues required for v3 public preview types issues related to types v3 Issues related to v3 of the package to support the new programming model
Milestone

Comments

@hossam-nasr
Copy link
Contributor

Related to #352 and #416. Currently, the Durable SDK auto-generates its .d.ts from the source-code .ts files. We should switch to manually authoring our type declarations and our .d.ts files. This has multiple benefits:

@ghost ghost added the Needs: Triage 🔍 label Feb 3, 2023
@hossam-nasr hossam-nasr self-assigned this Feb 3, 2023
@hossam-nasr hossam-nasr added v3 Issues related to v3 of the package to support the new programming model breaking-change types issues related to types preview-blocker issues required for v3 public preview and removed Needs: Triage 🔍 labels Feb 3, 2023
@hossam-nasr
Copy link
Contributor Author

Discussed some offline. As part of this, we should also try to switch from autogeneration of .d.ts files, to manual authoring of them. This should would help us become more intentional about which types we export, and also address #352. To do this, we should:

  1. Move all types/interfaces that we should expose publicly to the types directory (in normal .ts files)
  2. Separate class implementations from declarations, and move declarations to the types directory (also in .ts files)
  3. Switch to manual .d.ts file generation

Work for points 2 and 3 is already being done

Originally posted by @hossam-nasr in #416 (comment)

@hossam-nasr
Copy link
Contributor Author

Closed by #473

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking-change preview-blocker issues required for v3 public preview types issues related to types v3 Issues related to v3 of the package to support the new programming model
Projects
None yet
Development

No branches or pull requests

1 participant