nushell/docs/commands/if.md
JT 8c0a2d3c15
Auto-generate markdown command docs (#4451)
* Finish updating

* a couple improvements

* Update renames

* cleanup examples
2022-02-13 21:22:51 -05:00

36 lines
639 B
Markdown

---
title: if
layout: command
version: 0.59.0
---
Conditionally run a block.
## Signature
```> if (cond) (then_block) (else_expression)```
## Parameters
- `cond`: condition to check
- `then_block`: block to run if check succeeds
- `else_expression`: expression or block to run if check fails
## Examples
Output a value if a condition matches, otherwise return nothing
```shell
> if 2 < 3 { 'yes!' }
```
Output a value if a condition matches, else return another value
```shell
> if 5 < 3 { 'yes!' } else { 'no!' }
```
Chain multiple if's together
```shell
> if 5 < 3 { 'yes!' } else if 4 < 5 { 'no!' } else { 'okay!' }
```