Files
bitburner-src/markdown/bitburner.codingcontract.md
Michael Taylor dcd2f33f7c CODEBASE: Update api-documentor and api-extractor (#2320)
* 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>
2025-09-26 14:52:39 -07:00

1.6 KiB

Home > bitburner > CodingContract

CodingContract interface

Coding Contract API

Signature:

export interface CodingContract 

Methods

Method

Description

attempt(answer, filename, host)

Attempts a coding contract, returning a reward string on success or empty string on failure.

createDummyContract(type)

Generate a dummy contract.

getContract(filename, host)

Get various data about a specific contract.

getContractType(filename, host)

Get the type of a coding contract.

getContractTypes()

List all contract types.

getData(filename, host)

Get the input data.

getDescription(filename, host)

Get the description.

getNumTriesRemaining(filename, host)

Get the number of attempts remaining.