mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-17 06:48:42 +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>
118 lines
1.6 KiB
Markdown
118 lines
1.6 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md)
|
|
|
|
## CodingContract interface
|
|
|
|
Coding Contract API
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
export interface CodingContract
|
|
```
|
|
|
|
## Methods
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Method
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[attempt(answer, filename, host)](./bitburner.codingcontract.attempt.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Attempts a coding contract, returning a reward string on success or empty string on failure.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[createDummyContract(type)](./bitburner.codingcontract.createdummycontract.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Generate a dummy contract.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getContract(filename, host)](./bitburner.codingcontract.getcontract.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get various data about a specific contract.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getContractType(filename, host)](./bitburner.codingcontract.getcontracttype.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the type of a coding contract.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getContractTypes()](./bitburner.codingcontract.getcontracttypes.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
List all contract types.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getData(filename, host)](./bitburner.codingcontract.getdata.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the input data.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getDescription(filename, host)](./bitburner.codingcontract.getdescription.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the description.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[getNumTriesRemaining(filename, host)](./bitburner.codingcontract.getnumtriesremaining.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Get the number of attempts remaining.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|