> ## Documentation Index
> Fetch the complete documentation index at: https://stars-components.js.org/llms.txt
> Use this file to discover all available pages before exploring further.

# Interface: ListenOptions

Defined in: [packages/http-framework/src/lib/Client.ts:343](https://github.com/wolfstar-project/stars-components/blob/5aefd164bc5fc41e5a35d3abf908c288163dd354/packages/http-framework/src/lib/Client.ts#L343)

## Extends

* `Omit`\<`NetListenOptions`, `"path"` | `"readableAll"` | `"writableAll"`>

## Properties

### address?

> `optional` **address?**: `string`

Defined in: [packages/http-framework/src/lib/Client.ts:352](https://github.com/wolfstar-project/stars-components/blob/5aefd164bc5fc41e5a35d3abf908c288163dd354/packages/http-framework/src/lib/Client.ts#L352)

The address at which the server will be started.

***

### backlog?

> `optional` **backlog?**: `number`

Defined in: node\_modules/.pnpm/@types+node\@22.15.21/node\_modules/@types/node/net.d.ts:496

#### Inherited from

`Omit.backlog`

***

### exclusive?

> `optional` **exclusive?**: `boolean`

Defined in: node\_modules/.pnpm/@types+node\@22.15.21/node\_modules/@types/node/net.d.ts:497

#### Inherited from

`Omit.exclusive`

***

### host?

> `optional` **host?**: `string`

Defined in: node\_modules/.pnpm/@types+node\@22.15.21/node\_modules/@types/node/net.d.ts:498

#### Inherited from

`Omit.host`

***

### ipv6Only?

> `optional` **ipv6Only?**: `boolean`

Defined in: node\_modules/.pnpm/@types+node\@22.15.21/node\_modules/@types/node/net.d.ts:502

#### Default

```ts theme={"system"}
false;
```

#### Inherited from

`Omit.ipv6Only`

***

### port

> **port**: `number`

Defined in: [packages/http-framework/src/lib/Client.ts:347](https://github.com/wolfstar-project/stars-components/blob/5aefd164bc5fc41e5a35d3abf908c288163dd354/packages/http-framework/src/lib/Client.ts#L347)

The port at which the server will listen for requests.

#### Overrides

`Omit.port`

***

### postPath?

> `optional` **postPath?**: `` `/${string}` ``

Defined in: [packages/http-framework/src/lib/Client.ts:358](https://github.com/wolfstar-project/stars-components/blob/5aefd164bc5fc41e5a35d3abf908c288163dd354/packages/http-framework/src/lib/Client.ts#L358)

The path the HTTP server will listen to.

#### Default

```ts theme={"system"}
process.env.HTTP_POST_PATH ?? '/';
```

***

### reusePort?

> `optional` **reusePort?**: `boolean`

Defined in: node\_modules/.pnpm/@types+node\@22.15.21/node\_modules/@types/node/net.d.ts:503

#### Inherited from

`Omit.reusePort`

***

### serverOptions?

> `optional` **serverOptions?**: `ServerOptions`\<*typeof* `IncomingMessage`, *typeof* `ServerResponse`>

Defined in: [packages/http-framework/src/lib/Client.ts:363](https://github.com/wolfstar-project/stars-components/blob/5aefd164bc5fc41e5a35d3abf908c288163dd354/packages/http-framework/src/lib/Client.ts#L363)

The options to pass to the `createServer` function.

***

### signal?

> `optional` **signal?**: `AbortSignal`

Defined in: node\_modules/.pnpm/@types+node\@22.15.21/node\_modules/@types/node/events.d.ts:508

When provided the corresponding `AbortController` can be used to cancel an asynchronous action.

#### Inherited from

`Omit.signal`