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

# describeTrigger()

> Function exported by @botmesh/core.

```ts theme={null}
function describeTrigger(trigger): TriggerInfo;
```

Defined in: [flows/inventory.ts:206](https://github.com/andresayac/botmesh/blob/main/packages/core/src/flows/inventory.ts#L206)

Describe a [Trigger](https://botmesh.afaya.com.co/api/core/type-aliases/Trigger.md) as plain data, following the dispatcher's rules
(`matchTrigger`): strings default to normalized `equals`, RegExps run on the
raw body, predicates are opaque.

## Parameters

| Parameter | Type |
| - | - |
| `trigger` | [`Trigger`](https://botmesh.afaya.com.co/api/core/type-aliases/Trigger) |

## Returns

[`TriggerInfo`](https://botmesh.afaya.com.co/api/core/interfaces/TriggerInfo)

## Example

```ts theme={null}
describeTrigger({ pattern: 'factura', match: 'contains', scope: 'dm' }).label
// → 'contains "factura" (dm only)'
```


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