aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/emit.txt
blob: d8f17b45eca3db3ae7c19b44606c295356d1414a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
\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