aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src/emit.txt
blob: c0faab82f772399c6994266a3623ce3507ad6e85 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
\section emit emit - Emit a generic event

\subsection block-synopsis Synopsis
 <tt>emit EVENT_NAME [ARGUMENTS...]</tt>

\subsection emit-description Description

The emit builtin fires a generic fish event. Such events can be 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.

<pre>function event_test --on-event test_event
    echo event test: $argv
end

emit test_event something
</pre>