DOC: Specify optional parameters in hacknet functions (#515)

This commit is contained in:
Nikolai Korolev
2023-05-18 06:28:56 +01:00
committed by GitHub
parent 75706d273a
commit 2e9dc32deb
9 changed files with 32 additions and 32 deletions

View File

@@ -9,7 +9,7 @@ Upgrade the RAM of a hacknet node.
**Signature:**
```typescript
upgradeRam(index: number, n: number): boolean;
upgradeRam(index: number, n?: number): boolean;
```
## Parameters
@@ -17,7 +17,7 @@ upgradeRam(index: number, n: number): boolean;
| Parameter | Type | Description |
| --- | --- | --- |
| index | number | Index/Identifier of Hacknet Node. |
| n | number | Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. |
| n | number | _(Optional)_ Number of times to upgrade RAM. Must be positive. Rounded to nearest integer. Defaults to 1 if not specified. |
**Returns:**