@empathyco/x-components
Version:
Empathy X Components
27 lines (15 loc) • 1 kB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) > [@empathyco/x-components](./x-components.md) > [filterFalsyPayload](./x-components.filterfalsypayload.md)
## filterFalsyPayload() function
Creates a [Wire](./x-components.wire.md) that is only executed when the payload is truthy. A truthy value is whatever is not a [falsy value](https://developer.mozilla.org/en-US/docs/Glossary/Falsy)<!-- -->.
**Signature:**
```typescript
export declare function filterFalsyPayload<Payload>(wire: Wire<Exclude<Payload, null | undefined | false | 0 | ''>>): Wire<Payload>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| wire | [Wire](./x-components.wire.md)<!-- --><Exclude<Payload, null \| undefined \| false \| 0 \| ''>> | The wire to avoid executing when the payload is falsy. |
**Returns:**
[Wire](./x-components.wire.md)<!-- --><Payload>
The Wire function falsy filter.