@empathyco/x-components/docs/API-reference/api/x-components.filtertruthypayload.md

Empathy X Components

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@empathyco/x-components](./x-components.md) &gt; [filterTruthyPayload](./x-components.filtertruthypayload.md)

## filterTruthyPayload() function

Creates a [Wire](./x-components.wire.md) that is only executed when the payload is a [falsy value](https://developer.mozilla.org/en-US/docs/Glossary/Falsy)<!-- -->.

**Signature:**

```typescript
export declare function filterTruthyPayload<Payload>(wire: Wire<Payload>): Wire<Payload>;
```

## Parameters

<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

wire


</td><td>

[Wire](./x-components.wire.md)<!-- -->&lt;Payload&gt;


</td><td>

The wire to avoid executing when the payload is truthy.


</td></tr>
</tbody></table>

**Returns:**

[Wire](./x-components.wire.md)<!-- -->&lt;Payload&gt;

The Wire function truthy filter.