mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18:42 +02:00
79 lines
980 B
Markdown
79 lines
980 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 description.
|
||
|
||
**Signature:**
|
||
|
||
```typescript
|
||
getDescription(filename: string, host?: string): string;
|
||
```
|
||
|
||
## 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:**
|
||
|
||
string
|
||
|
||
Contract’s text description.
|
||
|
||
## Remarks
|
||
|
||
RAM cost: 5 GB
|
||
|
||
Get the full text description for the problem posed by the Coding Contract.
|
||
|