DOCUMENTATION: Clarify "completion" property of GraftingTask (#1713)

This commit is contained in:
catloversg 2024-10-22 11:22:17 +07:00 committed by GitHub
parent 3ce2ae5fd7
commit b72c03acf0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
3 changed files with 11 additions and 5 deletions

@ -4,7 +4,7 @@
## GraftingTask interface
Faction Work
Grafting Work
**Signature:**
@ -14,7 +14,9 @@ export interface GraftingTask
## Remarks
An object representing the current grafting status
An object representing the current grafting task
The "completion" property is a promise that resolves when the task is complete.
## Properties

@ -85,7 +85,7 @@
| [GoAnalysis](./bitburner.goanalysis.md) | Tools to analyze the IPvGO subnet. |
| [GoCheat](./bitburner.gocheat.md) | Illicit and dangerous IPvGO tools. Not for the faint of heart. Requires BitNode 14.2 to use. |
| [Grafting](./bitburner.grafting.md) | Grafting API |
| [GraftingTask](./bitburner.graftingtask.md) | Faction Work |
| [GraftingTask](./bitburner.graftingtask.md) | Grafting Work |
| [HackingFormulas](./bitburner.hackingformulas.md) | Hacking formulas |
| [HackingMultipliers](./bitburner.hackingmultipliers.md) | Hack related multipliers. |
| [Hacknet](./bitburner.hacknet.md) | Hacknet API |

@ -1708,9 +1708,13 @@ export interface FactionWorkTask {
}
/**
* Faction Work
* Grafting Work
*
* @remarks
* An object representing the current grafting status
* An object representing the current grafting task
*
* The "completion" property is a promise that resolves when the task is complete.
*
* @public
*/
export interface GraftingTask {