mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-11-10 01:33:54 +01:00
40 lines
1.2 KiB
Markdown
40 lines
1.2 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
|
||
|
|
|
||
|
|
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.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
scp(files: string | ReadonlyArray<string>, destination: Host): boolean;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| files | string \| ReadonlyArray<string> | Filename or an array of filenames of script/literature files to copy. |
|
||
|
|
| destination | [Host](./bitburner.host.md) | Host or IP of the destination server, which is the server to which the file will be copied. |
|
||
|
|
|
||
|
|
<b>Returns:</b>
|
||
|
|
|
||
|
|
boolean
|
||
|
|
|
||
|
|
True if the script/literature file is successfully copied over and false otherwise. If the files argument is an array then this function will return true if at least one of the files in the array is successfully copied.
|
||
|
|
|
||
|
|
## Remarks
|
||
|
|
|
||
|
|
0.6 GB
|
||
|
|
|
||
|
|
## Example
|
||
|
|
|
||
|
|
|
||
|
|
```js
|
||
|
|
//Copies hack-template.script from the current server to foodnstuff:
|
||
|
|
scp("hack-template.script", "foodnstuff");
|
||
|
|
```
|
||
|
|
|