Skip to content
This repository has been archived by the owner on Jul 17, 2023. It is now read-only.

feat: add typings for all packages in the project 馃帀 #63

Merged
merged 27 commits into from Dec 7, 2018

Conversation

robertrossmann
Copy link
Member

@robertrossmann robertrossmann commented Nov 27, 2018

This still needs work, but the basic API surface is typed now! 馃挭

To do:

  • Add typings for Atlas
  • expand typings for Action, Service, Hook
  • Add typings for @atlas.js/aws
  • Add typings for @atlas.js/braintree
  • Add typings for @atlas.js/cli
  • Add typings for @atlas.js/errors
  • Add typings for @atlas.js/firebase
  • Add typings for @atlas.js/generator-atlas
  • Add typings for @atlas.js/koa
  • Add typings for @atlas.js/mongoose
  • Add typings for @atlas.js/nodemailer
  • Add typings for @atlas.js/objection
  • Add typings for @atlas.js/repl
  • Add typings for @atlas.js/sequelize
  • Add typings for @atlas.js/templates
  • Explain how developers can define their own type definitions for registered components, so that typing atlas.actions. in an editor would show all known actions for this instance 馃挭
  • Explain how developers can type-hint the return values of this.component('service:objection') to show proper hints for that service etc.

Closes strvcom/backend-docs#68
Closes #55

@robertrossmann robertrossmann added enhancement work in progress This issue is currently being worked on documentation labels Nov 27, 2018
@robertrossmann robertrossmann self-assigned this Nov 27, 2018
@robertrossmann robertrossmann added this to the 2.1 milestone Nov 27, 2018
@coveralls
Copy link

coveralls commented Nov 27, 2018

Coverage Status

Coverage increased (+0.0005%) to 99.511% when pulling 9a78b99 on feat/typings into 2417929 on master.

@robertrossmann robertrossmann changed the title feat(atlas): add typings for the whole @atlas.js/atlas package 馃帀 feat(atlas): add typings for all packages in the project 馃帀 Dec 4, 2018
@robertrossmann robertrossmann changed the title feat(atlas): add typings for all packages in the project 馃帀 feat: add typings for all packages in the project 馃帀 Dec 4, 2018
 - @atlas.js/action@1.2.0-alpha.0
 - @atlas.js/atlas@2.2.0-alpha.0
 - @atlas.js/aws@2.1.0-alpha.0
 - @atlas.js/braintree@2.1.0-alpha.0
 - @atlas.js/cli@1.2.0-alpha.0
 - @atlas.js/component@2.2.0-alpha.0
 - @atlas.js/errors@0.3.0-alpha.0
 - @atlas.js/firebase@2.1.0-alpha.0
 - @atlas.js/generator-atlas@2.3.0-alpha.0
 - @atlas.js/hook@2.1.0-alpha.0
 - @atlas.js/koa@3.2.0-alpha.0
 - @atlas.js/mongoose@3.2.0-alpha.0
 - @atlas.js/nodemailer@2.1.0-alpha.0
 - @atlas.js/objection@2.2.0-alpha.0
 - @atlas.js/repl@2.1.0-alpha.0
 - @atlas.js/sequelize@2.1.0-alpha.0
 - @atlas.js/service@1.2.0-alpha.0
 - @atlas.js/templates@1.1.0-alpha.0
@robertrossmann robertrossmann merged commit 8b6af27 into master Dec 7, 2018
@robertrossmann robertrossmann deleted the feat/typings branch December 7, 2018 13:34
@robertrossmann
Copy link
Member Author

Merging now. Typed components are now released under npm's @next tag, if anyone wants to give it a shot. 馃帀

Documentation and any potential fixes to the type data will be done in a separate PR.

@robertrossmann robertrossmann removed the work in progress This issue is currently being worked on label Dec 7, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants