# addNats

- Module: [Aspire.Hosting.Nats](/reference/api/typescript/aspire.hosting.nats.md)
- Version: `13.4.0`
- Kind: `method`
- Source: [GitHub](https://github.com/microsoft/aspire)

Adds a NATS server resource to the application model.

## Definition

```typescript
interface IDistributedApplicationBuilder {
  // ... omitted for brevity
  addNats(
    name: string,
    port?: number,
    userName?: ParameterResource,
    password?: ParameterResource): NatsServerResource
}
```

## Parameters

- `name` (`string`)
- `port` (`number`) `optional`
- `userName` (`ParameterResource`) `optional`
- `password` (`ParameterResource`) `optional`

## Returns

[NatsServerResource](/reference/api/typescript/aspire.hosting.nats/natsserverresource.md) `builder`

## Applies to

- [IDistributedApplicationBuilder](/reference/api/typescript/aspire.hosting.nats/idistributedapplicationbuilder.md)