mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2024-09-20 04:48:38 +02:00
32 lines
802 B
Markdown
32 lines
802 B
Markdown
|
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|||
|
|
|
|||
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [CodingContract](./bitburner.codingcontract.md) > [getDescription](./bitburner.codingcontract.getdescription.md)
|
|||
|
|
|
|||
|
|
## CodingContract.getDescription() method
|
|||
|
|
|
|||
|
|
Get the full text description for the problem posed by the Coding Contract.
|
|||
|
|
|
|||
|
|
<b>Signature:</b>
|
|||
|
|
|
|||
|
|
```typescript
|
|||
|
|
getDescription(fn: string, host?: Host): string;
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Parameters
|
|||
|
|
|
|||
|
|
| Parameter | Type | Description |
|
|||
|
|
| --- | --- | --- |
|
|||
|
|
| fn | string | Filename of the contract. |
|
|||
|
|
| host | [Host](./bitburner.host.md) | Host or IP of the server containing the contract. Optional. Defaults to current server if not provided. |
|
|||
|
|
|
|||
|
|
<b>Returns:</b>
|
|||
|
|
|
|||
|
|
string
|
|||
|
|
|
|||
|
|
Contract’s text description.
|
|||
|
|
|
|||
|
|
## Remarks
|
|||
|
|
|
|||
|
|
5 GB
|
|||
|
|
|