Skip to content

Signal.Create() method

Defined in

Type: Signal Namespace: ReactiveUI.Primitives.Async.Signals Assembly: ReactiveUI.Primitives.Async.Core.dll

Applies to

net10.0, net10.0-browserwasm1.0, net10.0-desktop1.0, net9.0, net9.0-browserwasm1.0, net9.0-desktop1.0, net8.0, net8.0-ios17.5, net8.0-maccatalyst17.5, net8.0-macos14.2, net8.0-macos14.5, net8.0-tvos17.2, netstandard2.1, net462, net481, net471

Overloads

  • 1. public static ISignalAsync<T> Create<T>()
  • 2. public static ISignalAsync<T> Create<T>(SignalCreationOptions? options)

1. Overload

public static ISignalAsync<T> Create<T>()

View source

Summary: Creates a new asynchronous Signal instance for the specified type.

Type parameters

NameDescription
TThe type of elements processed by the Signal.

Returns: ISignalAsync -- An ISignalAsync that represents the newly created asynchronous Signal.

Remarks

The created Signal uses the default Signal creation options. Use the overload that accepts SignalCreationOptions to customize Signal behavior.

2. Overload

public static ISignalAsync<T> Create<T>(SignalCreationOptions? options)

View source

Summary: Creates a new asynchronous Signal instance with the specified publishing and state options.

Type parameters

NameDescription
TThe type of elements processed by the Signal.

Parameters

NameTypeDescription
options[SignalCreationOptions?](#The options that configure the publishing behavior and statefulness of the Signal. Must specify valid values for publishing and statelessness.

Returns: ISignalAsync -- An asynchronous Signal instance configured according to the specified options.

Remarks

Use this method to create an ISignalAsync with the desired concurrency and state management characteristics. The returned Signal type depends on the values provided in the options parameter.

Exceptions

TypeCondition
System.ArgumentOutOfRangeExceptionThrown if the specified combination of publishing and statelessness options is not supported.