DOCUMENTATION: Fix wrong param/return type and clarify ns.sleep, ns.asleep, ns.singularity.exportGame (#2242)

This commit is contained in:
catloversg
2025-07-17 07:06:34 +07:00
committed by GitHub
parent 5e3a2cce0f
commit 41548d8b7b
4 changed files with 21 additions and 11 deletions

View File

@@ -9,14 +9,14 @@ Suspends the script for n milliseconds. Doesn't block with concurrent calls.
**Signature:**
```typescript
asleep(millis: number): Promise<true>;
asleep(millis?: number): Promise<true>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| millis | number | Number of milliseconds to sleep. |
| millis | number | _(Optional)_ Number of milliseconds to sleep. Default to 0. |
**Returns:**
@@ -28,3 +28,5 @@ A promise that resolves to true when the sleep is completed.
RAM cost: 0 GB
Note that the actual delay may be longer than intended. For more information, please check https://developer.mozilla.org/en-US/docs/Web/API/Window/setTimeout\#delay.

View File

@@ -9,14 +9,14 @@ Suspends the script for n milliseconds.
**Signature:**
```typescript
sleep(millis: number): Promise<true>;
sleep(millis?: number): Promise<true>;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| millis | number | Number of milliseconds to sleep. |
| millis | number | _(Optional)_ Number of milliseconds to sleep. Default to 0. |
**Returns:**
@@ -28,6 +28,8 @@ A promise that resolves to true when the sleep is completed.
RAM cost: 0 GB
Note that the actual delay may be longer than intended. For more information, please check https://developer.mozilla.org/en-US/docs/Web/API/Window/setTimeout\#delay.
## Example

View File

@@ -9,11 +9,11 @@ Backup game save.
**Signature:**
```typescript
exportGame(): void;
exportGame(): Promise<void>;
```
**Returns:**
void
Promise&lt;void&gt;
## Remarks

View File

@@ -1862,7 +1862,7 @@ export interface Singularity {
* This function will automatically open the backup save prompt and claim the free faction favour if available.
*
*/
exportGame(): void;
exportGame(): Promise<void>;
/**
* Returns Backup save bonus availability.
@@ -6528,7 +6528,10 @@ export interface NS {
* @remarks
* RAM cost: 0 GB
*
* @param millis - Number of milliseconds to sleep.
* Note that the actual delay may be longer than intended. For more information, please check
* https://developer.mozilla.org/en-US/docs/Web/API/Window/setTimeout#delay.
*
* @param millis - Number of milliseconds to sleep. Default to 0.
* @example
* ```js
* // This will count from 1 to 10 in your terminal, with one number every 5 seconds
@@ -6539,17 +6542,20 @@ export interface NS {
* ```
* @returns A promise that resolves to true when the sleep is completed.
*/
sleep(millis: number): Promise<true>;
sleep(millis?: number): Promise<true>;
/**
* Suspends the script for n milliseconds. Doesn't block with concurrent calls.
* @remarks
* RAM cost: 0 GB
*
* @param millis - Number of milliseconds to sleep.
* Note that the actual delay may be longer than intended. For more information, please check
* https://developer.mozilla.org/en-US/docs/Web/API/Window/setTimeout#delay.
*
* @param millis - Number of milliseconds to sleep. Default to 0.
* @returns A promise that resolves to true when the sleep is completed.
*/
asleep(millis: number): Promise<true>;
asleep(millis?: number): Promise<true>;
/**
* Prints one or more values or variables to the scripts logs.