2022-02-14 02:22:51 +00:00
|
|
|
---
|
|
|
|
title: def
|
|
|
|
layout: command
|
|
|
|
version: 0.59.0
|
|
|
|
---
|
2021-01-15 07:21:18 +00:00
|
|
|
|
2022-02-14 02:22:51 +00:00
|
|
|
Define a custom command
|
2021-01-15 07:21:18 +00:00
|
|
|
|
2022-02-14 02:22:51 +00:00
|
|
|
## Signature
|
2021-01-15 07:21:18 +00:00
|
|
|
|
2022-02-14 02:22:51 +00:00
|
|
|
```> def (def_name) (params) (block)```
|
2021-01-15 07:21:18 +00:00
|
|
|
|
2022-02-14 02:22:51 +00:00
|
|
|
## Parameters
|
2021-01-27 17:31:29 +00:00
|
|
|
|
2022-02-14 02:22:51 +00:00
|
|
|
- `def_name`: definition name
|
|
|
|
- `params`: parameters
|
|
|
|
- `block`: body of the definition
|
2021-01-27 17:31:29 +00:00
|
|
|
|
2022-02-20 01:13:33 +00:00
|
|
|
## Examples
|
|
|
|
|
|
|
|
Define a command and run it
|
|
|
|
```shell
|
|
|
|
> def say-hi [] { echo 'hi' }; say-hi
|
|
|
|
```
|
|
|
|
|
|
|
|
Define a command and run it with parameter(s)
|
|
|
|
```shell
|
|
|
|
> def say-sth [sth: string] { echo $sth }; say-sth hi
|
|
|
|
```
|