IResourceWithConnectionString

Docs / Reference / Search TypeScript APIs / Aspire.Hosting / IResourceWithConnectionString

IResourceWithConnectionString

Docs Reference Search TypeScript APIs Aspire.Hosting IResourceWithConnectionString

Interface

📦 Aspire.Hosting v13.2.0

interface IResourceWithConnectionString {
  getConnectionProperty(key: string): ReferenceExpression;
  onConnectionStringAvailable(callback: (arg: ConnectionStringAvailableEvent) => void): IResourceWithConnectionString;
  withConnectionProperty(
      name: string,
      value: ReferenceExpression): IResourceWithConnectionString;
  withConnectionPropertyValue(
      name: string,
      value: string): IResourceWithConnectionString;
}

Methods

method getConnectionProperty

Gets a connection property by key

getConnectionProperty(key: string): ReferenceExpression

Parameters

key string

Returns

ReferenceExpression

method onConnectionStringAvailable builder

Subscribes to the ConnectionStringAvailable event

onConnectionStringAvailable(callback: (arg: ConnectionStringAvailableEvent) => void): IResourceWithConnectionString

Parameters

callback (arg: ConnectionStringAvailableEvent) => void

Returns

IResourceWithConnectionString

method withConnectionProperty builder

Adds a connection property with a reference expression

withConnectionProperty(
    name: string,
    value: ReferenceExpression): IResourceWithConnectionString

Parameters

name string

value ReferenceExpression

Returns

IResourceWithConnectionString

method withConnectionPropertyValue builder

Adds a connection property with a string value

withConnectionPropertyValue(
    name: string,
    value: string): IResourceWithConnectionString

Parameters

name string

value string

Returns

IResourceWithConnectionString