breejs / bree

Bree is a Node.js and JavaScript job task scheduler with worker threads, cron, Date, and human syntax. Built for @ladjs, @forwardemail, @spamscanner, @cabinjs.

https://jobscheduler.net

MIT License

3.06k stars 79 forks source link

Add Typescript Usage to the README #111

Closed danibram closed 3 years ago

danibram commented 3 years ago

Thanks for this awesome library @niftylettuce! And thanks to @ChrisEdgington for the guide to use with typescript. I added the steps on the README. If there are anything wrong please tell me, my english is not perfect ^^ Thanks

codecov-commenter commented 3 years ago

Codecov Report

Merging #111 (de95cbf) into master (426fc58) will not change coverage. The diff coverage is n/a.

@@            Coverage Diff            @@
##            master      #111   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            4         4           
  Lines          384       387    +3     
=========================================
+ Hits           384       387    +3

Impacted Files	Coverage Δ
src/job-utils.js	`100.00% <0.00%> (ø)`

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 426fc58...de95cbf. Read the comment docs.

niftylettuce commented 3 years ago

Just ping me once this is ready for merge!

Wazbat commented 3 years ago

This is only for using typescript worker threads, correct? What about using the bree library itself with typescript, or is that not yet possible?

Nisgrak commented 3 years ago

We didn't have a @types or bundled types, I don't think that gonna be so hard make a simple types, I try to make something.

Create a @types package or bundle with the lib itself? @niftylettuce

shadowgate15 commented 3 years ago

@Nisgrak That is what I have already done. It is already released on npm thanks to DefinitelyTyped.

@Wazbat This is for bree TypeScript bindings not for workers.

@niftylettuce this is ready!

shadowgate15 commented 3 years ago

@danibram could you convert the commit messages to conventional commits. Then we will be good to go.

danibram commented 3 years ago

I amended the last commit, is this ok? @shadowgate15