-
-
Notifications
You must be signed in to change notification settings - Fork 75
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: adding the package abstraction + doc
- Loading branch information
Showing
8 changed files
with
505 additions
and
31 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
--- | ||
title: Package loading | ||
description: Package loading groups multiple service registrations. | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Package loading | ||
|
||
Package loading groups multiple service registrations. | ||
|
||
## Registration | ||
|
||
The services can be assembled into a package, and then, exported all at once. | ||
|
||
```go | ||
// pkg/stores/package.go | ||
|
||
var Package = do.Package( | ||
do.Lazy(NewPostgresqlConnectionService), | ||
do.Lazy(NewUserRepository), | ||
do.Lazy(NewArticleRepository), | ||
do.EagerNamed("repository.logger", slog.New(slog.NewTextHandler(os.Stdout, nil))), | ||
) | ||
``` | ||
|
||
```go | ||
// cmd/main.go | ||
|
||
import ( | ||
"example/pkg/stores" | ||
"example/pkg/handlers" | ||
) | ||
|
||
func main() { | ||
injector := do.New(stores.Package) | ||
// ... | ||
|
||
// optional scope: | ||
scope := injector.Scope("handlers", handlers.Package) | ||
|
||
// ... | ||
} | ||
``` | ||
|
||
The traditional vocab can be translated for service registration: | ||
|
||
- `Provide[T](Injector)` -> `Lazy(T)` | ||
- `ProvideNamed[T](Injector, string)` -> `LazyNamed(string, T)` | ||
- `ProvideValue(Injector, T)` -> `Eager(T)` | ||
- `ProvideNamedValue[T](Injector, string, T)` -> `EagerNamed(string, T)` | ||
- `ProvideTransient[T](Injector)` -> `Transient(T)` | ||
- `ProvideNamedTransient[T](Injector, string)` -> `TransientNamed(string, T)` | ||
- `As[Initial, Alias](Injector)` -> `Bind[Initial, Alias]()` | ||
- `AsNamed[Initial, Alias](Injector, string, string)` -> `BindNamed[Initial, Alias](string, string)` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,57 @@ | ||
package do | ||
|
||
func Package(services ...func(i Injector)) func(Injector) { | ||
return func(injector Injector) { | ||
for i := range services { | ||
services[i](injector) | ||
} | ||
} | ||
} | ||
|
||
func Lazy[T any](p Provider[T]) func(Injector) { | ||
return func(injector Injector) { | ||
Provide(injector, p) | ||
} | ||
} | ||
|
||
func LazyNamed[T any](serviceName string, p Provider[T]) func(Injector) { | ||
return func(injector Injector) { | ||
ProvideNamed(injector, serviceName, p) | ||
} | ||
} | ||
|
||
func Eager[T any](value T) func(Injector) { | ||
return func(injector Injector) { | ||
ProvideValue(injector, value) | ||
} | ||
} | ||
|
||
func EagerNamed[T any](serviceName string, value T) func(Injector) { | ||
return func(injector Injector) { | ||
ProvideNamedValue(injector, serviceName, value) | ||
} | ||
} | ||
|
||
func Transient[T any](p Provider[T]) func(Injector) { | ||
return func(injector Injector) { | ||
ProvideTransient(injector, p) | ||
} | ||
} | ||
|
||
func TransientNamed[T any](serviceName string, p Provider[T]) func(Injector) { | ||
return func(injector Injector) { | ||
ProvideNamedTransient(injector, serviceName, p) | ||
} | ||
} | ||
|
||
func Bind[Initial any, Alias any]() func(Injector) { | ||
return func(injector Injector) { | ||
MustAs[Initial, Alias](injector) | ||
} | ||
} | ||
|
||
func BindNamed[Initial any, Alias any](initial string, alias string) func(Injector) { | ||
return func(injector Injector) { | ||
MustAsNamed[Initial, Alias](injector, initial, alias) | ||
} | ||
} |
Oops, something went wrong.