bitburner-src/markdown/bitburner.ns.hackanalyzesecurity.md
Snarling 65cd14e33b
DOC: Add ns documentation for possible sleeve tasks (#217)
* Add specific types for sleeve tasks
* Moved LocationName enum to overall enums file
* Add LocationName enum to those provided to player
* remove trailing s on CompanyPosNames enum (now CompanyPosName, in line with LocationName)
* Also regenerated all ns documentation. This leads to an expected error when checking for generated files, because PRs should not normally touch markdown files. Also leads to a lint failure in generated file bitburner.d.ts
* also removed some exporting from NetscriptDefinitions.d.ts for anything that wasn't imported somewhere else.
2022-11-20 12:07:22 -05:00

34 lines
879 B
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [NS](./bitburner.ns.md) &gt; [hackAnalyzeSecurity](./bitburner.ns.hackanalyzesecurity.md)
## NS.hackAnalyzeSecurity() method
Get the security increase for a number of threads.
<b>Signature:</b>
```typescript
hackAnalyzeSecurity(threads: number, hostname?: string): number;
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
| threads | number | Amount of threads that will be used. |
| hostname | string | Hostname of the target server. The number of threads is limited to the number needed to hack the server's maximum amount of money. |
<b>Returns:</b>
number
The security increase.
## Remarks
RAM cost: 1 GB
Returns the security increase that would occur if a hack with this many threads happened.