mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-01-24 05:20:04 +08:00
54 lines
1.3 KiB
Markdown
54 lines
1.3 KiB
Markdown
|
---
|
||
|
|
title: "job api"
|
||
|
|
description: "job API provides some besic functions for running a job"
|
||
|
|
---
|
||
|
|
|
||
|
|
# [Available APIs](../) >> job
|
||
|
|
|
||
|
|
<!-- vim-markdown-toc GFM -->
|
||
|
|
|
||
|
|
- [Intro](#intro)
|
||
|
|
- [Functions](#functions)
|
||
|
|
|
||
|
|
<!-- vim-markdown-toc -->
|
||
|
|
|
||
|
|
## Intro
|
||
|
|
|
||
|
|
job api provides a async job control api for vim and neovim.
|
||
|
|
|
||
|
|
```vim
|
||
|
|
let s:JOB = SpaceVim#api#import('job')
|
||
|
|
|
||
|
|
function! s:on_stdout(id, data, event) abort
|
||
|
|
" do something with stdout
|
||
|
|
endfunction
|
||
|
|
|
||
|
|
function! s:on_stderr(id, data, event) abort
|
||
|
|
" do something with stderr
|
||
|
|
endfunction
|
||
|
|
|
||
|
|
function! s:on_exit(id, data, event) abort
|
||
|
|
" handle exit code
|
||
|
|
endfunction
|
||
|
|
|
||
|
|
let cmd = ['python', 'test.py']
|
||
|
|
|
||
|
|
call s:JOB.start(cmd,
|
||
|
|
\ {
|
||
|
|
\ 'on_stdout' : function('s:on_stdout'),
|
||
|
|
\ 'on_stderr' : function('s:on_stderr'),
|
||
|
|
\ 'on_exit' : function('s:on_exit'),
|
||
|
|
\ }
|
||
|
|
\ )
|
||
|
|
```
|
||
|
|
|
||
|
|
## Functions
|
||
|
|
|
||
|
|
| function name | description |
|
||
|
|
| ------------------ | -------------------------------------------------- |
|
||
|
|
| `start(cmd, argv)` | start a job, return the job id |
|
||
|
|
| `send(id, data)` | send data to a job |
|
||
|
|
| `stop(id)` | stop a jobe with specific job id |
|
||
|
|
| `status(id)` | check the status of a job with the specific job id |
|
||
|
|
| `list()` | list all the jobs |
|