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

Fix ns documentation for scp and write

Browse Source
This commit is contained in:
Snarling 2022-08-23 22:06:05 -04:00
parent 076d79ed5a
commit 4d47785f28
2 changed files with 41 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/NetscriptFunctions.ts
View File

@ -1465,13 +1465,10 @@ const base: InternalAPI<NS> = {
},
write:
(ctx: NetscriptContext) =>
(_port: unknown, _data: unknown = "", _mode: unknown = "a"): void => {
const port = helpers.string(ctx, "port", _port);
(_handle: unknown, _data: unknown = "", _mode: unknown = "a"): void => {
let fn = helpers.string(ctx, "handle", _handle);
const data = helpers.string(ctx, "data", _data);
const mode = helpers.string(ctx, "mode", _mode);
if (isString(port)) {
// Write to script or text file
let fn = port;
if (!isValidFilePath(fn)) throw helpers.makeRuntimeErrorMsg(ctx, `Invalid filepath: ${fn}`);
if (fn.lastIndexOf("/") === 0) fn = removeLeadingSlash(fn);
@ -1491,6 +1488,7 @@ const base: InternalAPI<NS> = {
return script.updateRamUsage(Player, server.scripts);
} else {
// Write to text file
if (!fn.endsWith(".txt")) throw helpers.makeRuntimeErrorMsg(ctx, `Invalid filename: ${fn}`);
const txtFile = getTextFile(fn, server);
if (txtFile == null) {
createTextFile(fn, String(data), server);
@ -1503,9 +1501,6 @@ const base: InternalAPI<NS> = {
}
}
return;
} else {
throw helpers.makeRuntimeErrorMsg(ctx, `Invalid argument: ${port}`);
}
},
tryWritePort:
(ctx: NetscriptContext) =>

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

@ -5413,25 +5413,25 @@ export interface NS {
* ```ts
* // NS2:
* //Copies foo.lit from the helios server to the home computer:
* await ns.scp("foo.lit", "home", "helios" );
* ns.scp("foo.lit", "home", "helios" );
*
* //Tries to copy three files from rothman-uni to home computer:
* files = ["foo1.lit", "foo2.script", "foo3.script"];
* await ns.scp(files, "home", "rothman-uni");
* ns.scp(files, "home", "rothman-uni");
* ```
* @example
* ```ts
* //ns2, copies files from home to a target server
* const server = ns.args[0];
* const files = ["hack.js","weaken.js","grow.js"];
* await ns.scp(files, server, "home");
* ns.scp(files, server, "home");
* ```
* @param files - Filename or an array of filenames of script/literature files to copy.
* @param source - Host 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.
* @param destination - Host of the destination server, which is the server to which the file will be copied.
* @returns 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.
* @param source - Host 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.
* @returns 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.
*/
scp(files: string | string[], destination: string, source?: string): Promise<boolean>;
scp(files: string | string[], destination: string, source?: string): boolean;
/**
* List files on a server.
@ -5971,20 +5971,20 @@ export interface NS {
* @remarks
* RAM cost: 0 GB
*
* This function can be used to write data to a text file (.txt).
* This function can be used to write data to a text file (.txt) or a script (.js or .script).
*
* This function will write data to that text file. If the specified text file does not exist,
* This function will write data to that file. If the specified file does not exist,
* then it will be created. The third argument mode, defines how the data will be written to
* the text file. If *mode is set to “w”, then the data is written in “write” mode which means
* that it will overwrite all existing data on the text file. If mode is set to any other value
* the file. If *mode is set to “w”, then the data is written in “write” mode which means
* that it will overwrite all existing data on the file. If mode is set to any other value
* then the data will be written in “append” mode which means that the data will be added at the
* end of the text file.
* end of the file.
*
* @param handle - Filename of the text file that will be written to.
* @param handle - Filename to be written to.
* @param data - Data to write.
* @param mode - Defines the write mode. Only valid when writing to text files.
* @param mode - Defines the write mode.
*/
write(handle: string, data?: string[] | number | string, mode?: "w" | "a"): Promise<void>;
write(handle: string, data?: string[] | number | string, mode?: "w" | "a"): void;
/**
* Attempt to write to a port.