Skip to content
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

feat(types): add types for the module configuration and api #37

Merged
merged 11 commits into from
Nov 3, 2021
Merged

Conversation

rchl
Copy link
Collaborator

@rchl rchl commented Oct 30, 2021

This adds type for the nuxtNeo object in nuxt.config and for the $api object that is available from different places. The latter is an empty interface that the user would have to extend himself. In the future maybe this could be auto-generated but probably not a trivial task.

TODO:

  • Verify that everything is working as expected
  • Document

@codecov
Copy link

codecov bot commented Oct 30, 2021

Codecov Report

Merging #37 (58c316a) into master (bc77837) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #37   +/-   ##
=======================================
  Coverage   92.06%   92.06%           
=======================================
  Files           5        5           
  Lines         567      567           
=======================================
  Hits          522      522           
  Misses         45       45           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bc77837...58c316a. Read the comment docs.

@rchl rchl marked this pull request as ready for review October 31, 2021 19:45
@rchl
Copy link
Collaborator Author

rchl commented Oct 31, 2021

This was a bit pain to get right (typescript's extending of modules and ambient modules can be confusing) but I think I got it.

Once this is done, I think we can release a new version.

@ezypeeze
Copy link
Owner

ezypeeze commented Nov 3, 2021

This was a bit pain to get right (typescript's extending of modules and ambient modules can be confusing) but I think I got it.

Once this is done, I think we can release a new version.

Let me know when you feel like it's ready to review and merge

@rchl
Copy link
Collaborator Author

rchl commented Nov 3, 2021

It's ready now. Thanks.

@rchl rchl merged commit 6105698 into master Nov 3, 2021
@rchl rchl deleted the feat/types branch November 3, 2021 19:07
@rchl
Copy link
Collaborator Author

rchl commented Nov 3, 2021

Once this is done, I think we can release a new version.

@ezypeeze I believe I won't be able to trigger a new release since it requires permissions to push to master so feel free to make a release whenever you want.

@ezypeeze
Copy link
Owner

ezypeeze commented Nov 4, 2021

Once this is done, I think we can release a new version.

@ezypeeze I believe I won't be able to trigger a new release since it requires permissions to push to master so feel free to make a release whenever you want.

Released v4.3.0 & updated docs on gh-pages.

Feel free to suggest a better way to publish new releases, you helping alot!
What is your thoughts on better approachs?

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.

2 participants