addSurrealServer

Method

📦 CommunityToolkit.Aspire.Hosting.SurrealDb v13.4.0

interface IDistributedApplicationBuilder {
  // ... omitted for brevity
  addSurrealServer(
      name: string,
      userName?: ParameterResource,
      password?: ParameterResource,
      port?: number,
      path?: string,
      strictMode?: boolean): SurrealDbServerResource;
}

Signature

method addSurrealServer builder

Adds a SurrealDB resource to the application model. A container is used for local development. The default image is and the tag is .

addSurrealServer(
    name: string,
    userName?: ParameterResource,
    password?: ParameterResource,
    port?: number,
    path?: string,
    strictMode?: boolean): SurrealDbServerResource

Parameters

name string

userName ParameterResource optional

password ParameterResource optional

port number optional

path string optional = memory

strictMode boolean optional = False

Returns

SurrealDbServerResource

Applies to

This method applies to the following types:

type IDistributedApplicationBuilder