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 typescript definitions / add named export run #388

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ejhayes
Copy link

@ejhayes ejhayes commented May 19, 2021

Changes Made

  • Add typescript declarations to this project (see package.json which includes types reference and script generate:types)
  • Add named export run which exports both app and queue. Simplifies process of adding/removing queues from arena. This does not change default behavior!
  • Updates to README.md

Potential Risks

  • Type definitions will not work if they are missing from the package (new behavior so unlikely to break anything)

Test Plan

  • Ensure existing examples in example/ directory work. I have confirmed these work for me

Checklist

  • I've increased test coverage
  • Since this is a public repository, I've checked I'm not publishing private data in the code, commit comments, or this PR.

@ejhayes
Copy link
Author

ejhayes commented May 19, 2021

Hi @bradvogel - when you get a chance can you take a look at this PR?

@ejhayes ejhayes force-pushed the master branch 2 times, most recently from b2f65c8 to a6c2235 Compare May 19, 2021 21:44
@bradvogel bradvogel self-requested a review May 20, 2021 17:10
@bradvogel
Copy link
Contributor

Can you rebase on the latest origin/master? It looks like this PR diff is picking up some unrelated changes.

… Add named export run that exports middleware/queues in arena.
@ejhayes
Copy link
Author

ejhayes commented May 20, 2021

Changes rebased against upstream master. Take a look now @bradvogel

CHANGELOG.md Outdated
@@ -1,3 +1,9 @@
### [3.20.1](https://github.com/bee-queue/arena/compare/v3.20.0...v3.20.1) (2021-04-15)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No need to update this file. It's done automatically when this PR is merged. See https://github.com/bee-queue/arena/commits/master/CHANGELOG.md

@@ -1,4 +1,6 @@
*.hbs
*.min.js
*.min.css
*.d.ts
tsconfig.json
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CI is failing. I think you need to ignore the /dist folder here.

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.

None yet

2 participants