-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from futurum-dev/feature/improve-README.md
Improve README.md.
- Loading branch information
Showing
3 changed files
with
73 additions
and
7 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,10 +1,76 @@ | ||
| # Futurum.Microsoft.Extensions.DependencyInjection | ||
|
|
||
|  | ||
|  | ||
|  | ||
| [](https://coveralls.io/github/futurum-dev/dotnet.futurum.microsoft.extensions.dependencyinjection?branch=main) | ||
| [](https://www.nuget.org/packages/futurum.microsoft.extensions.dependencyinjection) | ||
|
|
||
| A dotnet library, that allows Microsoft.Extensions.DependencyInjection to work with Futurum.Core. | ||
| A dotnet library, that allows Microsoft.Extensions.DependencyInjection to work with Futurum.Core. It also adds support for modules and startables. | ||
|
|
||
| It also adds support for modules and startables. | ||
| ## TryGetService | ||
| Try to get the service object of the specified type. | ||
|
|
||
| ```csharp | ||
| var result = serviceProvider.TryGetService<ITestService>(); | ||
| ``` | ||
|
|
||
| ## Modules | ||
| A module allows you to break up registration into logical units. | ||
|
|
||
| ### IModule interface | ||
| Implements this interface to create a module. | ||
|
|
||
| ```csharp | ||
| public class TestModule : IModule | ||
| { | ||
| public void Load(IServiceCollection services) | ||
| { | ||
| services.AddSingleton<ITestService, TestService>(); | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### RegisterModule extension method | ||
| Allows you to register a module. | ||
|
|
||
| ```csharp | ||
| services.RegisterModule<TestModule>(); | ||
| ``` | ||
|
|
||
| ```csharp | ||
| services.RegisterModule(new TestModule()); | ||
| ``` | ||
|
|
||
| ## Startables | ||
| A startable is resolved at the start of the application lifecycle and is a place to perform actions as soon as the DependencyInjection container is built. | ||
|
|
||
| ### IStartable interface | ||
| Implements this interface to create a startable. | ||
|
|
||
| ```csharp | ||
| public class TestStartable : IStartable | ||
| { | ||
| public void Start() | ||
| { | ||
| // Do something | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### AddStartable extension method | ||
| Allows you to register a startable. | ||
|
|
||
| ```csharp | ||
| services.AddStartable<TestStartable>(); | ||
| ``` | ||
|
|
||
| ```csharp | ||
| services.AddStartable(new TestStartable()); | ||
| ``` | ||
|
|
||
| ### BuildServiceProviderWithStartables extension method | ||
| Creates a ServiceProvider containing services from the provided IServiceCollection and starts all *IStartable* instances. | ||
|
|
||
| ```csharp | ||
| var serviceProvider = services.BuildServiceProviderWithStartables(); | ||
| ``` |
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