> ## 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.

# DescribeOptions

> Interface exported by @botmesh/core.

Defined in: [flows/describe.ts:263](https://github.com/andresayac/botmesh/blob/main/packages/core/src/flows/describe.ts#L263)

Options for [describeFlows](https://botmesh.afaya.com.co/api/core/functions/describeFlows.md) / `bot.describe()`.

## Properties

### format?

```ts theme={null}
format?: "mermaid" | "json";
```

Defined in: [flows/describe.ts:265](https://github.com/andresayac/botmesh/blob/main/packages/core/src/flows/describe.ts#L265)

`'mermaid'` (default) returns a Mermaid flowchart string; `'json'` returns a [FlowGraph](https://botmesh.afaya.com.co/api/core/interfaces/FlowGraph.md).

***

### direction?

```ts theme={null}
direction?: "TD" | "TB" | "BT" | "LR" | "RL";
```

Defined in: [flows/describe.ts:267](https://github.com/andresayac/botmesh/blob/main/packages/core/src/flows/describe.ts#L267)

Mermaid layout direction (default `'TD'`, top-down).

***

### maxLabelLength?

```ts theme={null}
maxLabelLength?: number;
```

Defined in: [flows/describe.ts:273](https://github.com/andresayac/botmesh/blob/main/packages/core/src/flows/describe.ts#L273)

Max characters of each piece of user text (message, prompt, option, trigger)
in Mermaid labels; longer text is cut with `…`. Default `60`; `Infinity` keeps
everything. The JSON graph is never truncated.


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