Class chorus.autocmd.Spec

class chorus.autocmd.Spec

Autocommand specification

apply: (boolean | "all")?

Apply autocommands to current or all buffers. Default: false

buffer: (boolean | integer)?

Create autocommand for given buffer only (0 or true for current buffer). Default: false

callback: chorus.autocmd.Callback?

Callback to execute; can also be passed positionally

clear: boolean?

Clear autocommand group if specified. Default: true

command: string?

Ex command to execute; can also be passed positionally

create: boolean?

Create autocommand group if it doesn’t exist. Default: true

event: (string | string[])?

Event or events; can also be passed positionally

group: string?

Group for the created autocommands. Default: no group.

nested: boolean?

Allow nested autocommand triggering

once: boolean?

Unregister autocommand after triggering

pattern: (string | string[])?

Event pattern or patterns; can also be passed positionally

[integer]: (string | chorus.autocmd.Callback | chorus.autocmd.Spec)

Positional arguments

• A string is interpreted as the event or pattern (whichever hasn’t been specified yet)

• A callable is interpreted as the callback

• A table is a nested autocommand specification which inherits from its parents