mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-18 23:38:35 +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>
79 lines
1.1 KiB
Markdown
79 lines
1.1 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
||
|
||
[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getData](./bitburner.codingcontract.getdata.md)
|
||
|
||
## CodingContract.getData() method
|
||
|
||
Get the input data.
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
getData(filename: string, host?: string): any;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
<table><thead><tr><th>
|
||
|
||
Parameter
|
||
|
||
|
||
</th><th>
|
||
|
||
Type
|
||
|
||
|
||
</th><th>
|
||
|
||
Description
|
||
|
||
|
||
</th></tr></thead>
|
||
<tbody><tr><td>
|
||
|
||
filename
|
||
|
||
|
||
</td><td>
|
||
|
||
string
|
||
|
||
|
||
</td><td>
|
||
|
||
Filename of the contract.
|
||
|
||
|
||
</td></tr>
|
||
<tr><td>
|
||
|
||
host
|
||
|
||
|
||
</td><td>
|
||
|
||
string
|
||
|
||
|
||
</td><td>
|
||
|
||
_(Optional)_ Hostname/IP of the server containing the contract. Optional. Defaults to current server if not provided.
|
||
|
||
|
||
</td></tr>
|
||
</tbody></table>
|
||
|
||
**Returns:**
|
||
|
||
any
|
||
|
||
The specified contract’s data, data type depends on contract type.
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 5 GB
|
||
|
||
Get the data associated with the specific Coding Contract. Note that this is not the same as the contract’s description. This is just the data that the contract wants you to act on in order to solve the contract.
|
||
|