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

DOCUMENTATION: Clarify 2 forms of flag in ns.flags (#1283)

Browse Source
This commit is contained in:
catloversg 2024-05-17 18:57:10 +07:00 committed by GitHub
parent 7a4a973c06
commit 585e089976
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 33 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
markdown/bitburner.ns.flags.md
View File

@ -28,6 +28,12 @@ RAM cost: 0 GB
Allows Unix-like flag parsing.
We support 2 forms:
- Short form: the flag contains only 1 character, e.g. -v.
- Long form: the flag contains more than 1 character, e.g. --version.
## Example
@ -38,21 +44,24 @@ export async function main(ns) {
['server', 'foodnstuff'], // a default string means this flag is a string
['exclude', []], // a default array means this flag is a default array of string
['help', false], // a default boolean means this flag is a boolean
['v', false], // short form
]);
ns.tprint(data);
}
// [home ~/]> run example.js
// {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":false}
// {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":false,"v":false}
// [home ~/]> run example.js --delay 3000
// {"_":[],"server":"foodnstuff","exclude":[],"help":false,"delay":3000}
// {"_":[],"delay":3000,"server":"foodnstuff","exclude":[],"help":false,"v":false}
// [home ~/]> run example.js --delay 3000 --server harakiri-sushi
// {"_":[],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"}
// {"_":[],"delay":3000,"server":"harakiri-sushi","exclude":[],"help":false,"v":false}
// [home ~/]> run example.js --delay 3000 --server harakiri-sushi hello world
// {"_":["hello","world"],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"}
// {"_":["hello","world"],"delay":3000,"server":"harakiri-sushi","exclude":[],"help":false,"v":false}
// [home ~/]> run example.js --delay 3000 --server harakiri-sushi hello world --exclude a --exclude b
// {"_":["hello","world"],"help":false,"delay":3000,"server":"harakiri-sushi","exclude":["a","b"]}
// [home ~/]> run example.script --help
// {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":true}
// {"_":["hello","world"],"delay":3000,"server":"harakiri-sushi","exclude":["a","b"],"help":false,"v":false}
// [home ~/]> run example.js --help
// {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":true,"v":false}
// [home ~/]> run example.js -v
// {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":false,"v":true}
```

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

@ -7413,6 +7413,13 @@ export interface NS {
* RAM cost: 0 GB
*
* Allows Unix-like flag parsing.
*
* We support 2 forms:
*
* - Short form: the flag contains only 1 character, e.g. -v.
*
* - Long form: the flag contains more than 1 character, e.g. --version.
*
* @example
* ```js
* export async function main(ns) {
@ -7421,22 +7428,25 @@ export interface NS {
* ['server', 'foodnstuff'], // a default string means this flag is a string
* ['exclude', []], // a default array means this flag is a default array of string
* ['help', false], // a default boolean means this flag is a boolean
* ['v', false], // short form
* ]);
* ns.tprint(data);
* }
*
* // [home ~/]> run example.js
* // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":false}
* // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":false,"v":false}
* // [home ~/]> run example.js --delay 3000
* // {"_":[],"server":"foodnstuff","exclude":[],"help":false,"delay":3000}
* // {"_":[],"delay":3000,"server":"foodnstuff","exclude":[],"help":false,"v":false}
* // [home ~/]> run example.js --delay 3000 --server harakiri-sushi
* // {"_":[],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"}
* // {"_":[],"delay":3000,"server":"harakiri-sushi","exclude":[],"help":false,"v":false}
* // [home ~/]> run example.js --delay 3000 --server harakiri-sushi hello world
* // {"_":["hello","world"],"exclude":[],"help":false,"delay":3000,"server":"harakiri-sushi"}
* // {"_":["hello","world"],"delay":3000,"server":"harakiri-sushi","exclude":[],"help":false,"v":false}
* // [home ~/]> run example.js --delay 3000 --server harakiri-sushi hello world --exclude a --exclude b
* // {"_":["hello","world"],"help":false,"delay":3000,"server":"harakiri-sushi","exclude":["a","b"]}
* // [home ~/]> run example.script --help
* // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":true}
* // {"_":["hello","world"],"delay":3000,"server":"harakiri-sushi","exclude":["a","b"],"help":false,"v":false}
* // [home ~/]> run example.js --help
* // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":true,"v":false}
* // [home ~/]> run example.js -v
* // {"_":[],"delay":0,"server":"foodnstuff","exclude":[],"help":false,"v":true}
* ```
*/
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] };