Error handling docs #16
Labels
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
help wanted
Extra attention is needed
The messaging syntax (including errors) should be detailed in the readme.
Messages come through
event
. Thewhere
field looks like this:[s, e]/[sys, self]/[description]
Where
s
means "successful" (such ass/self/live@path
) ande
means "error" (such ase/sys/read
).self
means we failed.sys
means the operating system failed.The
description
is usually a function name, an api, or a path. It's something extra.These events always have the
kind
field aswatcher
(as opposed tofile
,dir
, etc).The
what
field varies. When a watcher first starts watching,what
iscreate
. When a watcher dies, it'sdestroy
. Error messages are usuallyother
.We need to put this in the readme.
The text was updated successfully, but these errors were encountered: