work on doc

markdown/bitburner.ns.hackanalyzethreads.md

@@ -0,0 +1,42 @@
+<!-- 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; [hackAnalyzeThreads](./bitburner.ns.hackanalyzethreads.md)
+
+## NS.hackAnalyzeThreads() method
+
+This function returns the number of script threads you need when running the hack command to steal the specified amount of money from the target server. If hackAmount is less than zero or greater than the amount of money available on the server, then this function returns -1.
+
+Warning: The value returned by this function isn’t necessarily a whole number.
+
+<b>Signature:</b>
+
+```typescript
+hackAnalyzeThreads(host: Host, hackAmount: number): number;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  host | [Host](./bitburner.host.md) | Hostname or IP of the target server to analyze. |
+|  hackAmount | number | Amount of money you want to hack from the server. |
+
+<b>Returns:</b>
+
+number
+
+The number of threads needed to hack the server for hackAmount money.
+
+## Remarks
+
+1 GB
+
+## Example
+
+
+```js
+//For example, let’s say the foodnstuff server has $10m and you run:
+hackAnalyzeThreads("foodnstuff", 1e6);
+//If this function returns 50, this means that if your next hack call is run on a script with 50 threads, it will steal $1m from the foodnstuff server.
+```
+