File size: 1,482 Bytes
8d756d3 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 |
# Creating your own errors
Using the [metadata](metadata.md) information, you can create your own custom error messages. Error messages are built of multiple parts:
- The title of the error
- The label of error message, which includes both the text of the label and the span to underline
You can use the [`error make`](/commands/docs/error_make.md) command to create your own error messages. For example, let's say you had your own command called `my-command` and you wanted to give an error back to the caller about something wrong with a parameter that was passed in.
First, you can take the span of where the argument is coming from:
```nu
let span = (metadata $x).span;
```
Next, you can create an error using the [`error make`](/commands/docs/error_make.md) command. This command takes in a record that describes the error to create:
```nu
error make {msg: "this is fishy", label: {text: "fish right here", span: $span } }
```
Together with your custom command, it might look like this:
```nu
def my-command [x] {
let span = (metadata $x).span;
error make {
msg: "this is fishy",
label: {
text: "fish right here",
span: (metadata $x).span
}
}
}
```
When called with a value, we'll now see an error message returned:
```nu
> my-command 100
Error:
× this is fishy
â•â”€[entry #5:1:1]
1 │ my-command 100
· ─┬─
· ╰── fish right here
╰────
```
|