mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-16 06:18:42 +02:00
DOCUMENTATION: Clarify ns.singularity.quitJob (#1979)
This commit is contained in:
@@ -9,14 +9,14 @@ Quit jobs by company.
|
||||
**Signature:**
|
||||
|
||||
```typescript
|
||||
quitJob(companyName?: CompanyName | `${CompanyName}`): void;
|
||||
quitJob(companyName: CompanyName | `${CompanyName}`): void;
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
| Parameter | Type | Description |
|
||||
| --- | --- | --- |
|
||||
| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)<!-- -->}\` | _(Optional)_ Name of the company. |
|
||||
| companyName | [CompanyName](./bitburner.companyname.md) \| \`${[CompanyName](./bitburner.companyname.md)<!-- -->}\` | Name of the company. |
|
||||
|
||||
**Returns:**
|
||||
|
||||
@@ -26,5 +26,7 @@ void
|
||||
|
||||
RAM cost: 3 GB \* 16/4/1
|
||||
|
||||
This function will finish work with the company provided and quit any jobs.
|
||||
This function quits the current work if it's from the provided company.
|
||||
|
||||
This function affects you and all sleeves. If a sleeve is working for this company, it will stop working and be idle.
|
||||
|
||||
|
||||
6
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
6
src/ScriptEditor/NetscriptDefinitions.d.ts
vendored
@@ -2130,12 +2130,14 @@ export interface Singularity {
|
||||
* @remarks
|
||||
* RAM cost: 3 GB * 16/4/1
|
||||
*
|
||||
* This function quits the current work if it's from the provided company.
|
||||
*
|
||||
* This function will finish work with the company provided and quit any jobs.
|
||||
* This function affects you and all sleeves. If a sleeve is working for this company, it will stop working and be
|
||||
* idle.
|
||||
*
|
||||
* @param companyName - Name of the company.
|
||||
*/
|
||||
quitJob(companyName?: CompanyName | `${CompanyName}`): void;
|
||||
quitJob(companyName: CompanyName | `${CompanyName}`): void;
|
||||
|
||||
/**
|
||||
* Apply for a job at a company.
|
||||
|
||||
Reference in New Issue
Block a user