Skip to content

Update documentation for AddHostedService. #123658

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.

Sign up for GitHub

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

Merged
cincuranet merged 4 commits into from
Jan 30, 2026
Merged

Update documentation for AddHostedService. #123658

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c4fc28d
Update documentation for AddHostedService.
cincuranet Jan 27, 2026
08fa903
Copilot feedback.
cincuranet Jan 27, 2026
a92410b
Improve docs.
cincuranet Jan 27, 2026
16a8562
Merge branch 'main' into hostedservice-docs
cincuranet Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions ...Microsoft.Extensions.Hosting.Abstractions/src/ServiceCollectionHostedServiceExtensions.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,19 @@ public static class ServiceCollectionHostedServiceExtensions
/// <summary>
/// Add an <see cref="IHostedService"/> registration for the given type.
/// </summary>
/// <remarks>
/// Note that this creates registration for <see cref="IHostedService"/> specifically. Not for the actual <c>THostedService</c> type.
/// If you want to register the actual type, you must do so separately.
/// </remarks>
/// <example>
/// <para>
/// The following code shows how to register a hosted service while also registering the actual <c>THostedService</c> type.
/// </para>
/// <code language="csharp">
/// services.AddSingleton&lt;SomeService&gt;();
/// services.AddHostedService(sp => sp.GetRequiredService&lt;SomeService&gt;());
/// </code>
/// </example>
/// <typeparam name="THostedService">An <see cref="IHostedService"/> to register.</typeparam>
/// <param name="services">The <see cref="IServiceCollection"/> to register with.</param>
/// <returns>The original <see cref="IServiceCollection"/>.</returns>
Expand All @@ -30,6 +43,19 @@ public static class ServiceCollectionHostedServiceExtensions
/// <summary>
/// Add an <see cref="IHostedService"/> registration for the given type.
/// </summary>
/// <remarks>
/// Note that this creates registration for <see cref="IHostedService"/> specifically. Not for the actual <c>THostedService</c> type.
/// If you want to register the actual type, you must do so separately.
/// </remarks>
/// <example>
/// <para>
/// The following code shows how to register a hosted service while also registering the actual <c>THostedService</c> type.
/// </para>
/// <code language="csharp">
/// services.AddSingleton&lt;SomeService&gt;(implementationFactory);
/// services.AddHostedService(sp => sp.GetRequiredService&lt;SomeService&gt;());
/// </code>
/// </example>
/// <typeparam name="THostedService">An <see cref="IHostedService"/> to register.</typeparam>
/// <param name="services">The <see cref="IServiceCollection"/> to register with.</param>
/// <param name="implementationFactory">A factory to create new instances of the service implementation.</param>
Expand Down
Loading