addSurrealServer

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /CommunityToolkit.Aspire.Hosting.SurrealDb
5. /addSurrealServer

Method

📦 CommunityToolkit.Aspire.Hosting.SurrealDb v13.5.0

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

Signature

methodaddSurrealServerbuilder

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): SurrealDbServerResource

Parameters

namestring

userNameParameterResourceoptional

passwordParameterResourceoptional

portnumberoptional

pathstringoptional= memory

Returns

SurrealDbServerResource

Applies to

This method applies to the following types:

typeIDistributedApplicationBuilder