mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-24 02:03:01 +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>
116 lines
1.9 KiB
Markdown
116 lines
1.9 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [scp](./bitburner.ns.scp.md)
|
||
|
||
## NS.scp() method
|
||
|
||
Copy file between servers.
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
scp(files: string | string[], destination: string, source?: string): boolean;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
<table><thead><tr><th>
|
||
|
||
Parameter
|
||
|
||
|
||
</th><th>
|
||
|
||
Type
|
||
|
||
|
||
</th><th>
|
||
|
||
Description
|
||
|
||
|
||
</th></tr></thead>
|
||
<tbody><tr><td>
|
||
|
||
files
|
||
|
||
|
||
</td><td>
|
||
|
||
string \| string\[\]
|
||
|
||
|
||
</td><td>
|
||
|
||
Filename or an array of filenames of script/literature files to copy. Note that if a file is located in a subdirectory, the filename must include the leading `/`<!-- -->.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
destination
|
||
|
||
|
||
</td><td>
|
||
|
||
string
|
||
|
||
|
||
</td><td>
|
||
|
||
Hostname/IP of the destination server, which is the server to which the file will be copied.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
source
|
||
|
||
|
||
</td><td>
|
||
|
||
string
|
||
|
||
|
||
</td><td>
|
||
|
||
_(Optional)_ Hostname/IP of the source server, which is the server from which the file will be copied. This argument is optional and if it’s omitted the source will be the current server.
|
||
|
||
|
||
</td></tr>
|
||
</tbody></table>
|
||
|
||
**Returns:**
|
||
|
||
boolean
|
||
|
||
True if the file is successfully copied over and false otherwise. If the files argument is an array then this function will return false if any of the operations failed.
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 0.6 GB
|
||
|
||
Copies a script or literature (.lit) file(s) to another server. The files argument can be either a string specifying a single file to copy, or an array of strings specifying multiple files to copy.
|
||
|
||
## Example 1
|
||
|
||
|
||
```js
|
||
//Copies foo.lit from the helios server to the home computer:
|
||
ns.scp("foo.lit", "home", "helios" );
|
||
|
||
//Tries to copy three files from rothman-uni to home computer:
|
||
const files = ["foo1.lit", "foo2.txt", "foo3.js"];
|
||
ns.scp(files, "home", "rothman-uni");
|
||
```
|
||
|
||
## Example 2
|
||
|
||
|
||
```js
|
||
const server = ns.args[0];
|
||
const files = ["hack.js", "weaken.js", "grow.js"];
|
||
ns.scp(files, server, "home");
|
||
```
|
||
|