ResourceNotificationService

Handle

📦 Aspire.Hosting v13.4.0

interface ResourceNotificationService extends IDisposable {
  publishResourceUpdate(
      resource: IResource,
      state?: string,
      stateStyle?: string): void;
  tryGetResourceState(resourceName: string): ResourceEventDto;
  waitForDependencies(resource: IResource): void;
  waitForResourceHealthy(resourceName: string): ResourceEventDto;
  waitForResourceState(
      resourceName: string,
      targetState?: string): void;
  waitForResourceStates(
      resourceName: string,
      targetStates: string[]): string;
}

6 members

Methods

method publishResourceUpdate

Publishes an update for a resource's state.

publishResourceUpdate(
    resource: IResource,
    state?: string,
    stateStyle?: string): void

Parameters

resource IResource

state string optional

stateStyle string optional

method tryGetResourceState

Tries to get the current state of a resource.

tryGetResourceState(resourceName: string): ResourceEventDto

Parameters

resourceName string

Returns

ResourceEventDto

method waitForDependencies

Waits for all dependencies of a resource to be ready.

waitForDependencies(resource: IResource): void

Parameters

resource IResource

method waitForResourceHealthy

Waits for a resource to become healthy.

waitForResourceHealthy(resourceName: string): ResourceEventDto

Parameters

resourceName string

Returns

ResourceEventDto

method waitForResourceState

Waits for a resource to reach a specified state.

waitForResourceState(
    resourceName: string,
    targetState?: string): void

Parameters

resourceName string

targetState string optional

method waitForResourceStates

Waits for a resource to reach one of the specified states.

waitForResourceStates(
    resourceName: string,
    targetStates: string[]): string

Parameters

resourceName string

targetStates string[]

Returns

string