mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-21 16:52:55 +02:00
Michael Taylor
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
109 lines
1.6 KiB
Markdown
109 lines
1.6 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [kill](./bitburner.ns.kill_1.md)
|
|
|
|
## NS.kill() method
|
|
|
|
Terminate the script(s) with the provided filename, host, and script arguments.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
kill(filename: string, host?: string, ...args: ScriptArg[]): boolean;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
filename
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
Filename of the script to kill.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
host
|
|
|
|
|
|
</td><td>
|
|
|
|
string
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Hostname/IP where the script to kill is running. Defaults to the current server.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
args
|
|
|
|
|
|
</td><td>
|
|
|
|
[ScriptArg](./bitburner.scriptarg.md)<!-- -->\[\]
|
|
|
|
|
|
</td><td>
|
|
|
|
Arguments of the script to kill.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
boolean
|
|
|
|
True if the scripts were successfully killed, and false otherwise.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 0.5 GB
|
|
|
|
Kills the script(s) with the provided filename, running on the specified host with the specified args. To instead kill a script using its PID, see [the other ns.kill entry](./bitburner.ns.kill.md)<!-- -->.
|
|
|
|
## Example
|
|
|
|
|
|
```js
|
|
// kill the script "foo.js" on the same server the current script is running from, with no arguments
|
|
ns.kill("foo.js");
|
|
|
|
// kill the script "foo.js" on the "n00dles" server with no arguments.
|
|
ns.kill("foo.js", "n00dles");
|
|
|
|
// kill the script foo.js on the current server that was run with the arguments [1, “foodnstuff”, false]:
|
|
ns.kill("foo.js", ns.getHostname(), 1, "foodnstuff", false);
|
|
```
|
|
|