Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
xxadev
vscode
提交
58f8e3b9
V
vscode
项目概览
xxadev
/
vscode
与 Fork 源项目一致
从无法访问的项目Fork
通知
2
Star
0
Fork
0
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
V
vscode
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
体验新版 GitCode,发现更多精彩内容 >>
提交
58f8e3b9
编写于
5月 10, 2019
作者:
D
Daniel Imms
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
Update node-pty typings
上级
5aa30cb1
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
98 addition
and
55 deletion
+98
-55
src/typings/node-pty.d.ts
src/typings/node-pty.d.ts
+98
-55
未找到文件。
src/typings/node-pty.d.ts
浏览文件 @
58f8e3b9
/**
* Copyright (c) 2017, Daniel Imms (MIT License).
* Copyright (c) 2018, Microsoft Corporation (MIT License).
*/
declare
module
'
node-pty
'
{
...
...
@@ -11,76 +12,118 @@ declare module 'node-pty' {
* escaped properly.
* @param options The options of the terminal.
* @see CommandLineToArgvW https://msdn.microsoft.com/en-us/library/windows/desktop/bb776391(v=vs.85).aspx
* @see Parsing C++ Com
ma
nd-Line Arguments https://msdn.microsoft.com/en-us/library/17w5ykft.aspx
* @see Parsing C++ Com
am
nd-Line Arguments https://msdn.microsoft.com/en-us/library/17w5ykft.aspx
* @see GetCommandLine https://msdn.microsoft.com/en-us/library/windows/desktop/ms683156.aspx
*/
export
function
spawn
(
file
:
string
,
args
:
string
[]
|
string
,
options
:
IPtyForkOptions
):
IPty
;
export
interface
IPtyForkOptions
{
name
?:
string
;
cols
?:
number
;
rows
?:
number
;
cwd
?:
string
;
env
?:
{
[
key
:
string
]:
string
};
uid
?:
number
;
gid
?:
number
;
encoding
?:
string
;
/**
* Whether to use the experimental ConPTY system on Windows. This setting will be ignored on
* non-Windows.
*/
experimentalUseConpty
?:
boolean
;
name
?:
string
;
cols
?:
number
;
rows
?:
number
;
cwd
?:
string
;
env
?:
{
[
key
:
string
]:
string
};
uid
?:
number
;
gid
?:
number
;
encoding
?:
string
;
/**
* Whether to use the experimental ConPTY system on Windows. When this is not set, ConPTY will
* be used when the Windows build number is >= 18309 (it's available in 17134 and 17692 but is
* too unstable to enable by default).
*
* This setting does nothing on non-Windows.
*/
experimentalUseConpty
?:
boolean
;
}
/**
* An interface representing a pseudoterminal, on Windows this is emulated via the winpty library.
*/
export
interface
IPty
{
/**
* The process ID of the outer process.
*/
pid
:
number
;
/**
* The process ID of the outer process.
*/
pid
:
number
;
/**
* The title of the active proces
s.
*/
process
:
string
;
/**
* The column size in character
s.
*/
cols
:
number
;
/**
* Adds a listener to the data event, fired when data is returned from the pty.
* @param event The name of the event.
* @param listener The callback function.
*/
on
(
event
:
'
data
'
,
listener
:
(
data
:
string
)
=>
void
):
void
;
/**
* The row size in characters.
*/
rows
:
number
;
/**
* Adds a listener to the exit event, fired when the pty exits.
* @param event The name of the event.
* @param listener The callback function, exitCode is the exit code of the process and signal is
* the signal that triggered the exit. signal is not supported on Windows.
*/
on
(
event
:
'
exit
'
,
listener
:
(
exitCode
:
number
,
signal
?:
number
)
=>
void
):
void
;
/**
* The title of the active process.
*/
process
:
string
;
/**
* Resizes the dimensions of the pty.
* @param columns The number of columns to use
.
* @param rows The number of rows to use
.
*/
resize
(
columns
:
number
,
rows
:
number
):
void
;
/**
* Adds an event listener for when a data event fires. This happens when data is returned from
* the pty
.
* @returns an `IDisposable` to stop listening
.
*/
onData
:
IEvent
<
string
>
;
/**
* Writes data to the pty
.
* @param data The data to write
.
*/
write
(
data
:
string
):
void
;
/**
* Adds an event listener for when an exit event fires. This happens when the pty exits
.
* @returns an `IDisposable` to stop listening
.
*/
onExit
:
IEvent
<
{
exitCode
:
number
,
signal
?:
number
}
>
;
/**
* Kills the pty.
* @param signal The signal to use, defaults to SIGHUP. If the TIOCSIG/TIOCSIGNAL ioctl is not
* supported then the process will be killed instead. This parameter is not supported on
* Windows.
* @throws Will throw when signal is used on Windows.
*/
kill
(
signal
?:
string
):
void
;
/**
* Adds a listener to the data event, fired when data is returned from the pty.
* @param event The name of the event.
* @param listener The callback function.
* @deprecated Use IPty.onData
*/
on
(
event
:
'
data
'
,
listener
:
(
data
:
string
)
=>
void
):
void
;
/**
* Adds a listener to the exit event, fired when the pty exits.
* @param event The name of the event.
* @param listener The callback function, exitCode is the exit code of the process and signal is
* the signal that triggered the exit. signal is not supported on Windows.
* @deprecated Use IPty.onExit
*/
on
(
event
:
'
exit
'
,
listener
:
(
exitCode
:
number
,
signal
?:
number
)
=>
void
):
void
;
/**
* Resizes the dimensions of the pty.
* @param columns THe number of columns to use.
* @param rows The number of rows to use.
*/
resize
(
columns
:
number
,
rows
:
number
):
void
;
/**
* Writes data to the pty.
* @param data The data to write.
*/
write
(
data
:
string
):
void
;
/**
* Kills the pty.
* @param signal The signal to use, defaults to SIGHUP. This parameter is not supported on
* Windows.
* @throws Will throw when signal is used on Windows.
*/
kill
(
signal
?:
string
):
void
;
}
/**
* An object that can be disposed via a dispose function.
*/
export
interface
IDisposable
{
dispose
():
void
;
}
/**
* An event that can be listened to.
* @returns an `IDisposable` to stop listening.
*/
export
interface
IEvent
<
T
>
{
(
listener
:
(
e
:
T
)
=>
any
):
IDisposable
;
}
}
\ No newline at end of file
}
\ No newline at end of file
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录