xsteadfastx/workgroups
1
0
Fork 0
Code Issues Pull Requests Projects Releases 7 Wiki Activity

docs: readme
All checks were successful
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/tag Build is passing
Details

Browse Source
This commit is contained in:
Marvin Preuss 2021-09-27 11:06:57 +02:00
parent d34ef66014
commit e83812188f
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -1,7 +1,7 @@
# workgroups # workgroups
Package workgroups is a little helper for creating workers Package workgroups is a little helper for creating workers
with the help of sync.Errgroup. with the help of [sync.Errgroup](https://pkg.go.dev/golang.org/x/sync/errgroup).
![build](https://ci.xsfx.dev/api/badges/xsteadfastx/workgroups/status.svg) ![build](https://ci.xsfx.dev/api/badges/xsteadfastx/workgroups/status.svg)
![coverage](https://codecov.io/gh/xsteadfastx/workgroups/branch/main/graph/badge.svg?token=RZE1ZWJSYA) ![coverage](https://codecov.io/gh/xsteadfastx/workgroups/branch/main/graph/badge.svg?token=RZE1ZWJSYA)
@ -52,10 +52,12 @@ Close closes the queue channel.
Start starts the configured number of workers and waits for jobs. Start starts the configured number of workers and waits for jobs.
#### func (*Dispatcher) [Wait](/workgroups.go#L113) #### func (*Dispatcher) [Wait](/workgroups.go#L114)
`func (d *Dispatcher) Wait() error` `func (d *Dispatcher) Wait() error`
Wait for all jobs to finnish.
### type [Job](/workgroups.go#L40) ### type [Job](/workgroups.go#L40)
`type Job struct { ... }` `type Job struct { ... }`