felixfoertsch/bitburner-src
1
0
Fork 0
mirror of https://github.com/bitburner-official/bitburner-src.git synced 2026-05-05 23:27:55 +02:00
Code Issues Packages Projects Releases Wiki Activity

DOCUMENTATION: Clarify ns.singularity.quitJob (#1979)

Browse Source
This commit is contained in:
catloversg
2025-02-28 01:03:46 +07:00
committed by GitHub
parent 05f0ba1ac6
commit fed3cf1af2
2 changed files with 9 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
markdown/bitburner.singularity.quitjob.md
+5 -3
View File
@@ -9,14 +9,14 @@ Quit jobs by company.
**Signature:** **Signature:**
```typescript ```typescript
quitJob(companyName?: CompanyName | `${CompanyName}`): void; quitJob(companyName: CompanyName | `${CompanyName}`): void;
``` ```
## Parameters ## Parameters
| Parameter | Type | Description | | 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:** **Returns:**
@@ -26,5 +26,7 @@ void
RAM cost: 3 GB \* 16/4/1 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.
src/ScriptEditor/NetscriptDefinitions.d.ts
Vendored
+4 -2
View File
@@ -2130,12 +2130,14 @@ export interface Singularity {
* @remarks * @remarks
* RAM cost: 3 GB * 16/4/1 * 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. * @param companyName - Name of the company.
*/ */
quitJob(companyName?: CompanyName | `${CompanyName}`): void; quitJob(companyName: CompanyName | `${CompanyName}`): void;
/** /**
* Apply for a job at a company. * Apply for a job at a company.