diff --git a/autoload/SpaceVim/api/job.vim b/autoload/SpaceVim/api/job.vim index 3688c7936..fa11685b3 100644 --- a/autoload/SpaceVim/api/job.vim +++ b/autoload/SpaceVim/api/job.vim @@ -24,6 +24,43 @@ " on_exit: exit event handler (function name or Funcref) " " cwd: working directory of the job; defaults to current directory +" +" stop(id) +" +" stop job via job id. +" +" send(id, data) +" +" send {data} to specific job. +" +" status(id) +" +" return the job status of a specific job. +" +" +" This api also can be use in lua: +" +" Example: > +" local job = require('spacevim.api.job') +" +" local function on_stdout(id, data) +" +" end +" +" local function on_stderr(id, data) +" +" end +" +" local function on_exit(id, code, single) +" +" end +" +" job.start({'vim', '--version'}, +" on_stdout = on_stdout, +" on_stderr = on_stderr, +" on_exit = on_exit +" ) +" < diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt index fdd2b1418..ad949540a 100644 --- a/doc/SpaceVim.txt +++ b/doc/SpaceVim.txt @@ -6639,6 +6639,44 @@ start({cmd}[, {opt}]) cwd: working directory of the job; defaults to current directory +stop(id) + + stop job via job id. + +send(id, data) + + send {data} to specific job. + +status(id) + + return the job status of a specific job. + + +This api also can be use in lua: + +Example: +> + local job = require('spacevim.api.job') + + local function on_stdout(id, data) + + end + + local function on_stderr(id, data) + + end + + local function on_exit(id, code, single) + + end + + job.start({'vim', '--version'}, + on_stdout = on_stdout, + on_stderr = on_stderr, + on_exit = on_exit + ) +< + ============================================================================== LOGGER *SpaceVim-api-logger*