> ## Documentation Index
> Fetch the complete documentation index at: https://botmesh.afaya.com.co/llms.txt
> Use this file to discover all available pages before exploring further.

# StreamResult

> Interface exported by @botmesh/core.

Defined in: [streaming/types.ts:85](https://github.com/andresayac/botmesh/blob/main/packages/core/src/streaming/types.ts#L85)

What `ctx.stream()` resolves with.

## Properties

### text

```ts theme={null}
text: string;
```

Defined in: [streaming/types.ts:87](https://github.com/andresayac/botmesh/blob/main/packages/core/src/streaming/types.ts#L87)

Full text received from the source (before splitting).

***

### messages

```ts theme={null}
messages: SentMessage<unknown>[];
```

Defined in: [streaming/types.ts:89](https://github.com/andresayac/botmesh/blob/main/packages/core/src/streaming/types.ts#L89)

Every message sent (several when the text was split or chunked).

***

### strategy

```ts theme={null}
strategy: StreamStrategy;
```

Defined in: [streaming/types.ts:91](https://github.com/andresayac/botmesh/blob/main/packages/core/src/streaming/types.ts#L91)

Strategy actually used at the end (after any fallback).

***

### cancelled

```ts theme={null}
cancelled: boolean;
```

Defined in: [streaming/types.ts:93](https://github.com/andresayac/botmesh/blob/main/packages/core/src/streaming/types.ts#L93)

`true` when `signal` aborted or the user stopped the draft.

***

### stoppedByUser

```ts theme={null}
stoppedByUser: boolean;
```

Defined in: [streaming/types.ts:95](https://github.com/andresayac/botmesh/blob/main/packages/core/src/streaming/types.ts#L95)

`true` when the user pressed the transport's stop button.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.