Personal_mirrors/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-11-22 07:33:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

scan doc

Browse Source
This commit is contained in:
Olivier Gagnon 2021-12-16 15:21:00 -05:00
parent 1b680431b6
commit e16fba2418
7 changed files with 18 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
dist/bitburner.d.ts vendored
View File

@ -2580,15 +2580,14 @@ export declare interface NS extends Singularity {
* @remarks
* RAM cost: 0.2 GB
*
* Returns an array containing the hostnames or IPs of all servers that are one
* node way from the specified target server. The hostnames/IPs in the returned
* Returns an array containing the hostnames of all servers that are one
* node way from the specified target server. The hostnames in the returned
* array are strings.
*
* @param host - Hostname of the server to scan.
* @param hostnames - Optional boolean specifying whether the function should output hostnames (if true) or IP addresses (if false).
* @returns Returns an string of hostnames or IP.
* @returns Returns an string of hostnames.
*/
scan(host: string, hostnames?: boolean): string[];
scan(host?: string): string[];
/**
* Runs NUKE.exe on a server.

23
input/bitburner.api.json
View File

@ -18037,24 +18037,16 @@
{
"kind": "MethodSignature",
"canonicalReference": "bitburner!NS#scan:member(1)",
"docComment": "/**\n * Get the list servers connected to a server.\n *\n * @remarks\n *\n * RAM cost: 0.2 GB\n *\n * Returns an array containing the hostnames or IPs of all servers that are one node way from the specified target server. The hostnames/IPs in the returned array are strings.\n *\n * @param host - Hostname of the server to scan.\n *\n * @param hostnames - Optional boolean specifying whether the function should output hostnames (if true) or IP addresses (if false).\n *\n * @returns Returns an string of hostnames or IP.\n */\n",
"docComment": "/**\n * Get the list servers connected to a server.\n *\n * @remarks\n *\n * RAM cost: 0.2 GB\n *\n * Returns an array containing the hostnames of all servers that are one node way from the specified target server. The hostnames in the returned array are strings.\n *\n * @param host - Hostname of the server to scan.\n *\n * @returns Returns an string of hostnames.\n */\n",
"excerptTokens": [
{
"kind": "Content",
"text": "scan(host: "
"text": "scan(host?: "
},
{
"kind": "Content",
"text": "string"
},
{
"kind": "Content",
"text": ", hostnames?: "
},
{
"kind": "Content",
"text": "boolean"
},
{
"kind": "Content",
"text": "): "
@ -18070,8 +18062,8 @@
],
"isOptional": false,
"returnTypeTokenRange": {
"startIndex": 5,
"endIndex": 6
"startIndex": 3,
"endIndex": 4
},
"releaseTag": "Public",
"overloadIndex": 1,
@ -18082,13 +18074,6 @@
"startIndex": 1,
"endIndex": 2
}
},
{
"parameterName": "hostnames",
"parameterTypeTokenRange": {
"startIndex": 3,
"endIndex": 4
}
}
],
"name": "scan"

2
main.bundle.js
View File

File diff suppressed because one or more lines are too long

2
main.bundle.js.map
View File

File diff suppressed because one or more lines are too long

2
markdown/bitburner.ns.md
View File

@ -131,7 +131,7 @@ export async function main(ns) {
| [relaysmtp(host)](./bitburner.ns.relaysmtp.md) | Runs relaySMTP.exe on a server. |
| [rm(name, host)](./bitburner.ns.rm.md) | Delete a file. |
| [run(script, numThreads, args)](./bitburner.ns.run.md) | Start another script on the current server. |
| [scan(host, hostnames)](./bitburner.ns.scan.md) | Get the list servers connected to a server. |
| [scan(host)](./bitburner.ns.scan.md) | Get the list servers connected to a server. |
| [scp(files, source, destination)](./bitburner.ns.scp.md) | Copy file between servers. |
| [scriptKill(script, host)](./bitburner.ns.scriptkill.md) | Kill all scripts with a filename. |
| [scriptRunning(script, host)](./bitburner.ns.scriptrunning.md) | Check if any script with a filename is running. |

7
markdown/bitburner.ns.scan.md
View File

@ -9,7 +9,7 @@ Get the list servers connected to a server.
<b>Signature:</b>
```typescript
scan(host: string, hostnames?: boolean): string[];
scan(host?: string): string[];
```
## Parameters
@ -17,17 +17,16 @@ scan(host: string, hostnames?: boolean): string[];
| Parameter | Type | Description |
| --- | --- | --- |
| host | string | Hostname of the server to scan. |
| hostnames | boolean | Optional boolean specifying whether the function should output hostnames (if true) or IP addresses (if false). |
<b>Returns:</b>
string\[\]
Returns an string of hostnames or IP.
Returns an string of hostnames.
## Remarks
RAM cost: 0.2 GB
Returns an array containing the hostnames or IPs of all servers that are one node way from the specified target server. The hostnames/IPs in the returned array are strings.
Returns an array containing the hostnames of all servers that are one node way from the specified target server. The hostnames in the returned array are strings.

9
src/ScriptEditor/NetscriptDefinitions.d.ts vendored
View File

@ -4182,15 +4182,14 @@ export interface NS extends Singularity {
* @remarks
* RAM cost: 0.2 GB
*
* Returns an array containing the hostnames or IPs of all servers that are one
* node way from the specified target server. The hostnames/IPs in the returned
* Returns an array containing the hostnames of all servers that are one
* node way from the specified target server. The hostnames in the returned
* array are strings.
*
* @param host - Hostname of the server to scan.
* @param hostnames - Optional boolean specifying whether the function should output hostnames (if true) or IP addresses (if false).
* @returns Returns an string of hostnames or IP.
* @returns Returns an string of hostnames.
*/
scan(host: string, hostnames?: boolean): string[];
scan(host?: string): string[];
/**
* Runs NUKE.exe on a server.