mirror of
https://github.com/fofolee/uTools-ProcessKiller.git
synced 2025-06-08 22:51:45 +08:00
144 lines
5.4 KiB
Markdown
144 lines
5.4 KiB
Markdown
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
|
|
|
|
|
|
# powershell
|
|
|
|
[![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [](https://github.com/IonicaBizau/ama) [](https://www.npmjs.com/package/powershell) [](https://www.npmjs.com/package/powershell) [](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
|
|
|
|
<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
|
|
|
|
> Run PowerShell scripts and commands from Node.js.
|
|
|
|
## Why?
|
|
|
|
|
|
- Actively maintained
|
|
- Improved codebase.
|
|
- Written in ES2015
|
|
|
|
|
|
## :cloud: Installation
|
|
|
|
```sh
|
|
# Using npm
|
|
npm install --save powershell
|
|
|
|
# Using yarn
|
|
yarn add powershell
|
|
```
|
|
|
|
|
|
## :clipboard: Example
|
|
|
|
|
|
|
|
```js
|
|
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:
|
|
|
|
1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
|
|
2. For bug reports and feature requests, open issues. :bug:
|
|
|
|
3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :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 are `Restricted`, `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][contributing].
|
|
|
|
|
|
## :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:
|
|
- [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
|
|
- [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
|
|
- [![Support me on Patreon][badge_patreon]][patreon]—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`](https://github.com/rannn505/node-powershell) by [@rann505](https://github.com/rannn505/).
|
|
|
|
## :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`](https://github.com/havardh/workflow/tree/master/packages/workflow-wm-windows#readme) (by Håvard Wormdal Høiby)—Windows window manager adapter for workflow
|
|
- [`workflow-wm-windows-python`](https://github.com/havardh/workflow/tree/master/packages/workflow-wm-windows-python#readme) (by Håvard Wormdal Høiby)—Windows window manager adapter for workflow using python
|
|
|
|
## :scroll: License
|
|
|
|
[MIT][license] © [Ionică Bizău][website]
|
|
|
|
|
|
[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
|
|
[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
|
|
[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
|
|
[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
|
|
|
|
[patreon]: https://www.patreon.com/ionicabizau
|
|
[amazon]: http://amzn.eu/hRo9sIZ
|
|
[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW
|
|
|
|
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(https%3A%2F%2Fionicabizau.net)&year=2015#license-mit
|
|
[website]: https://ionicabizau.net
|
|
[contributing]: /CONTRIBUTING.md
|
|
[docs]: /DOCUMENTATION.md
|