mirror of
https://github.com/fish-shell/fish-shell.git
synced 2024-11-29 13:23:53 +08:00
29 lines
802 B
ReStructuredText
29 lines
802 B
ReStructuredText
|
\section emit emit - Emit a generic event
|
||
|
|
|
||
|
|
\subsection emit-synopsis Synopsis
|
||
|
|
\fish{synopsis}
|
||
|
|
emit EVENT_NAME [ARGUMENTS...]
|
||
|
|
\endfish
|
||
|
|
|
||
|
|
\subsection emit-description Description
|
||
|
|
|
||
|
|
`emit` emits, or fires, an event. Events are delivered to, or caught by, special functions called event handlers. The arguments are passed to the event handlers as function arguments.
|
||
|
|
|
||
|
|
|
||
|
|
\subsection emit-example Example
|
||
|
|
|
||
|
|
The following code first defines an event handler for the generic event named 'test_event', and then emits an event of that type.
|
||
|
|
|
||
|
|
\fish
|
||
|
|
function event_test --on-event test_event
|
||
|
|
echo event test: $argv
|
||
|
|
end
|
||
|
|
|
||
|
|
emit test_event something
|
||
|
|
\endfish
|
||
|
|
|
||
|
|
|
||
|
|
\subsection emit-notes Notes
|
||
|
|
|
||
|
|
Note that events are only sent to the current fish process as there is no way to send events from one fish process to another.
|