mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-17 14:59:16 +02:00
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>
94 lines
1.2 KiB
Markdown
94 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) > [printf](./bitburner.ns.printf.md)
|
||
|
||
## NS.printf() method
|
||
|
||
Prints a formatted string to the script’s logs.
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
printf(format: string, ...args: any[]): void;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
<table><thead><tr><th>
|
||
|
||
Parameter
|
||
|
||
|
||
</th><th>
|
||
|
||
Type
|
||
|
||
|
||
</th><th>
|
||
|
||
Description
|
||
|
||
|
||
</th></tr></thead>
|
||
<tbody><tr><td>
|
||
|
||
format
|
||
|
||
|
||
</td><td>
|
||
|
||
string
|
||
|
||
|
||
</td><td>
|
||
|
||
Format of the message.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
args
|
||
|
||
|
||
</td><td>
|
||
|
||
any\[\]
|
||
|
||
|
||
</td><td>
|
||
|
||
Value(s) to be printed.
|
||
|
||
|
||
</td></tr>
|
||
</tbody></table>
|
||
|
||
**Returns:**
|
||
|
||
void
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 0 GB
|
||
|
||
- See [print](./bitburner.ns.print.md) for how to add color to your printed strings.
|
||
|
||
- For more detail, see: https://github.com/alexei/sprintf.js
|
||
|
||
## Example
|
||
|
||
|
||
```js
|
||
const name = "Bit";
|
||
const age = 4;
|
||
ns.printf("My name is %s.", name);
|
||
ns.printf("I'm %d seconds old.", age);
|
||
ns.printf("My age in binary is %b.", age);
|
||
ns.printf("My age in scientific notation is %e.", age);
|
||
ns.printf("In %d seconds, I'll be %s.", 6, "Byte");
|
||
ns.printf("Am I a nibble? %t", (4 === age));
|
||
ns.ui.openTail();
|
||
```
|
||
|