mirror of
https://github.com/bitburner-official/bitburner-src.git
synced 2026-04-27 19:37:07 +02:00
Michael Taylor
dcd2f33f7c
* Update api-documentor and api-extractor. #1566 follow-up.
I have verified that the HTML/markdown table generation bug in
[#4878](https://github.com/microsoft/rushstack/issues/4878) in rushstack
for api-documentor has been fixed as per rushstack#5256. The testcase
[repro](https://github.com/catloversg/api-documenter-bug-pr-4578) now
produces the correct expected output.
I have confirmed that the generated output in bitburner from
`npm run doc` now generated HTML tables, and correctly inserts
a blank line between the </table> and the follow line (e.g. Returns).
Stylisticly it could use some whitespace, but it is correctly rendered.
This commit is only the updated packages, not the updated generated
documentation. I assume that is automatically generated by the GitHub
workflow.
* Follow up to 5f732a6f35, include `npm run doc` changed docs.
* Add missing license info
* Fix React warning
---------
Co-authored-by: CatLover <152669316+catloversg@users.noreply.github.com>
90 lines
1.5 KiB
Markdown
90 lines
1.5 KiB
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [bitburner](./bitburner.md) > [Singularity](./bitburner.singularity.md) > [workForCompany](./bitburner.singularity.workforcompany.md)
|
|
|
|
## Singularity.workForCompany() method
|
|
|
|
Work for a company.
|
|
|
|
**Signature:**
|
|
|
|
```typescript
|
|
workForCompany(companyName: CompanyName, focus?: boolean): boolean;
|
|
```
|
|
|
|
## Parameters
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Parameter
|
|
|
|
|
|
</th><th>
|
|
|
|
Type
|
|
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
companyName
|
|
|
|
|
|
</td><td>
|
|
|
|
[CompanyName](./bitburner.companyname.md)
|
|
|
|
|
|
</td><td>
|
|
|
|
Name of company to work for. Must be an exact match.
|
|
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
focus
|
|
|
|
|
|
</td><td>
|
|
|
|
boolean
|
|
|
|
|
|
</td><td>
|
|
|
|
_(Optional)_ Acquire player focus on this work operation. Optional. Defaults to true.
|
|
|
|
|
|
</td></tr>
|
|
</tbody></table>
|
|
|
|
**Returns:**
|
|
|
|
boolean
|
|
|
|
True if the player starts working, and false otherwise.
|
|
|
|
## Remarks
|
|
|
|
RAM cost: 3 GB \* 16/4/1
|
|
|
|
This function will set you to start working at your current job at a specified company at which you are employed. If you are already in the middle of some “working” action (such as working for a faction, training at a gym, or creating a program), then running this function will cancel that action.
|
|
|
|
This function will return true if the player starts working, and false otherwise.
|
|
|
|
## Example
|
|
|
|
|
|
```js
|
|
const companyName = "Noodle Bar";
|
|
const success = ns.singularity.workForCompany(companyName);
|
|
if (!success) ns.tprint(`ERROR: Failed to start work at ${companyName}.`);
|
|
```
|
|
|