mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-21 16:52:55 +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>
96 lines
2.3 KiB
Markdown
96 lines
2.3 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [NS](./bitburner.ns.md) > [flags](./bitburner.ns.flags.md)
|
|
|
|
## NS.flags() method
|
|
|
|
Parse command line flags.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
flags(schema: [string, string | number | boolean | string[]][]): { [key: string]: ScriptArg | string[] };
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
schema
|
|
|
|
|
|
</td><td>
|
|
|
|
\[string, string \| number \| boolean \| string\[\]\]\[\]
|
|
|
|
|
|
</td><td>
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
{ \[key: string\]: [ScriptArg](./bitburner.scriptarg.md) \| string\[\] }
|
|
|
|
## Remarks
|
|
|
|
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) {
|
|
const data = ns.flags([
|
|
['delay', 0], // a default number means this flag is a number
|
|
['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,"v":false}
|
|
// [home /]> run example.js --delay 3000
|
|
// {"_":[],"delay":3000,"server":"foodnstuff","exclude":[],"help":false,"v":false}
|
|
// [home /]> run example.js --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"],"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"],"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}
|
|
```
|
|
|