mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2025-01-09 23:07:40 +01:00
32 lines
793 B
Markdown
32 lines
793 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?: string): string;
|
||
```
|
||
|
||
## Parameters
|
||
|
||
| Parameter | Type | Description |
|
||
| --- | --- | --- |
|
||
| fn | string | Filename of the contract. |
|
||
| host | string | 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
|
||
|
||
RAM cost: 5 GB
|
||
|