@abdfnx/powershell 中文文档教程
powershell
从 Node.js 运行 PowerShell 脚本和命令。
Why?
- Actively maintained
- Improved codebase.
- Written in ES2015
:cloud: Installation
# Using npm
npm install --save powershell
# Using yarn
yarn add powershell
:clipboard: Example
const PowerShell = require("powershell");
// Start the process
let ps = new PowerShell("echo 'powershell is awesome'");
// Handle process errors (e.g. powershell not found)
ps.on("error", (err) => {
console.error(err);
});
// Stdout
ps.on("output", (data) => {
console.log(data);
});
// Stderr
ps.on("error-output", (data) => {
console.error(data);
});
// End
ps.on("end", (code) => {
// Do Something on end
});
:question: Get Help
获得帮助的方法很少:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. :bug:
- For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
PowerShell(input, opt, cb)
Params
- String
input
: The command or PowerShell script ro execute. - Object
opt
: An object containing the following fields: debug
(Boolean): Turn on/off the debug messages (default:false
).noprofile
(Boolean): Turn on/off noprofile parameter (default:true
).executionpolicy
(Enum): Run powershell with specified executionpolicy (default: System default). Valid enum values areRestricted
,AllSigned
,RemoteSigned
,Unrestricted
,Bypass
,Undefined
.PSCore
(Boolean) : Turn on/off 'pwsh' the executable for PowerShell Core as opposed to Windowes PowerShell (default: 'false').- Function
cb
: The callback function (optional).
:yum: How to contribute
有想法吗? 发现错误? 查看如何贡献。
:sparkling_heart: Support my projects
我几乎开源了所有我能开源的东西,我试着回复每个需要帮助使用这些项目的人。 明显地, 这需要时间。 您可以免费在您的应用程序中集成和使用这些项目! 您甚至可以更改源代码并重新分发(甚至转售)。
但是,如果您从中获得一些收益,或者只是想鼓励我继续创作,您可以通过几种方式做到这一点:
主演和分享您喜欢的项目 :rocket:
比特币——您可以通过以下地址(或扫描下面的代码)向我发送比特币:
1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
谢谢! :heart:
:cake: Thanks
此模块主要基于 node-powershell
by @rann505。
:dizzy: Where is this library used?
如果您在其中一个项目中使用此库,请将其添加到此列表中。 :sparkles:
workflow-wm-windows
workflow-wm-windows-python
win-screenoff
rdc-generator
ptc-integrity
:scroll: License
[文档]:/DOCUMENTATION.md
powershell
Run PowerShell scripts and commands from Node.js.
Why?
- Actively maintained
- Improved codebase.
- Written in ES2015
:cloud: Installation
# Using npm
npm install --save powershell
# Using yarn
yarn add powershell
:clipboard: Example
const PowerShell = require("powershell");
// Start the process
let ps = new PowerShell("echo 'powershell is awesome'");
// Handle process errors (e.g. powershell not found)
ps.on("error", (err) => {
console.error(err);
});
// Stdout
ps.on("output", (data) => {
console.log(data);
});
// Stderr
ps.on("error-output", (data) => {
console.error(data);
});
// End
ps.on("end", (code) => {
// Do Something on end
});
:question: Get Help
There are few ways to get help:
- Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
- For bug reports and feature requests, open issues. :bug:
- For direct and quick help, you can use Codementor. :rocket:
:memo: Documentation
PowerShell(input, opt, cb)
Params
- String
input
: The command or PowerShell script ro execute. - Object
opt
: An object containing the following fields: debug
(Boolean): Turn on/off the debug messages (default:false
).noprofile
(Boolean): Turn on/off noprofile parameter (default:true
).executionpolicy
(Enum): Run powershell with specified executionpolicy (default: System default). Valid enum values areRestricted
,AllSigned
,RemoteSigned
,Unrestricted
,Bypass
,Undefined
.PSCore
(Boolean) : Turn on/off 'pwsh' the executable for PowerShell Core as opposed to Windowes PowerShell (default: 'false').- Function
cb
: The callback function (optional).
:yum: How to contribute
Have an idea? Found a bug? See how to contribute.
:sparkling_heart: Support my projects
I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).
However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below):
1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6
Thanks! :heart:
:cake: Thanks
This module is heavily based on node-powershell
by @rann505.
:dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:
workflow-wm-windows
workflow-wm-windows-python
win-screenoff
rdc-generator
ptc-integrity
:scroll: License
[docs]: /DOCUMENTATION.md