DNET: Update documentation (#2483)

markdown/bitburner.darknetinstability.authenticationdurationmultiplier.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetInstability](./bitburner.darknetinstability.md) &gt; [authenticationDurationMultiplier](./bitburner.darknetinstability.authenticationdurationmultiplier.md)
+
+## DarknetInstability.authenticationDurationMultiplier property
+
+The increase in time that authentication takes, as a decimal
+
+**Signature:**
+
+```typescript
+authenticationDurationMultiplier: number;
+```

markdown/bitburner.darknetinstability.authenticationtimeoutchance.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [DarknetInstability](./bitburner.darknetinstability.md) &gt; [authenticationTimeoutChance](./bitburner.darknetinstability.authenticationtimeoutchance.md)
+
+## DarknetInstability.authenticationTimeoutChance property
+
+The chance that authentication will time out instead of resolving, as a decimal
+
+**Signature:**
+
+```typescript
+authenticationTimeoutChance: number;
+```

markdown/bitburner.darknetinstability.md

@@ -2,15 +2,76 @@
 
 [Home](./index.md) > [bitburner](./bitburner.md) > [DarknetInstability](./bitburner.darknetinstability.md)
 
-## DarknetInstability type
+## DarknetInstability interface
 
 Instability of the darknet caused by excessive backdoor-ing of servers.
 
 **Signature:**
 
 ```typescript
-type DarknetInstability = {
-  authenticationDurationMultiplier: number;
-  authenticationTimeoutChance: number;
-};
+interface DarknetInstability 
 ```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[authenticationDurationMultiplier](./bitburner.darknetinstability.authenticationdurationmultiplier.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The increase in time that authentication takes, as a decimal
+
+
+</td></tr>
+<tr><td>
+
+[authenticationTimeoutChance](./bitburner.darknetinstability.authenticationtimeoutchance.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The chance that authentication will time out instead of resolving, as a decimal
+
+
+</td></tr>
+</tbody></table>
+

markdown/bitburner.heartbleedoptions.additionalmsec.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [HeartbleedOptions](./bitburner.heartbleedoptions.md) &gt; [additionalMsec](./bitburner.heartbleedoptions.additionalmsec.md)
+
+## HeartbleedOptions.additionalMsec property
+
+The number of additional milliseconds to add to the run time of the heartbleed request. Default is 0. Must be a non-negative integer.
+
+**Signature:**
+
+```typescript
+additionalMsec?: number;
+```

markdown/bitburner.heartbleedoptions.logstocapture.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [HeartbleedOptions](./bitburner.heartbleedoptions.md) &gt; [logsToCapture](./bitburner.heartbleedoptions.logstocapture.md)
+
+## HeartbleedOptions.logsToCapture property
+
+The number of log lines to remove from the server. Default is 1. Must be a positive integer.
+
+**Signature:**
+
+```typescript
+logsToCapture?: number;
+```

markdown/bitburner.heartbleedoptions.md

@@ -2,16 +2,95 @@
 
 [Home](./index.md) > [bitburner](./bitburner.md) > [HeartbleedOptions](./bitburner.heartbleedoptions.md)
 
-## HeartbleedOptions type
+## HeartbleedOptions interface
 
 Options to change the behavior of [heartbleed](./bitburner.darknet.heartbleed.md) API.
 
 **Signature:**
 
 ```typescript
-type HeartbleedOptions = {
-  peek?: boolean;
-  logsToCapture?: number;
-  additionalMsec?: number;
-};
+interface HeartbleedOptions 
 ```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[additionalMsec?](./bitburner.heartbleedoptions.additionalmsec.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The number of additional milliseconds to add to the run time of the heartbleed request. Default is 0. Must be a non-negative integer.
+
+
+</td></tr>
+<tr><td>
+
+[logsToCapture?](./bitburner.heartbleedoptions.logstocapture.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ The number of log lines to remove from the server. Default is 1. Must be a positive integer.
+
+
+</td></tr>
+<tr><td>
+
+[peek?](./bitburner.heartbleedoptions.peek.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ If true, looks at the most recent log lines but does not remove them. Default is false.
+
+
+</td></tr>
+</tbody></table>
+

markdown/bitburner.heartbleedoptions.peek.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [HeartbleedOptions](./bitburner.heartbleedoptions.md) &gt; [peek](./bitburner.heartbleedoptions.peek.md)
+
+## HeartbleedOptions.peek property
+
+If true, looks at the most recent log lines but does not remove them. Default is false.
+
+**Signature:**
+
+```typescript
+peek?: boolean;
+```

markdown/bitburner.md

@@ -368,6 +368,17 @@ Darknet API
 Darknet formulas
 
 
+</td></tr>
+<tr><td>
+
+[DarknetInstability](./bitburner.darknetinstability.md)
+
+
+</td><td>
+
+Instability of the darknet caused by excessive backdoor-ing of servers.
+
+
 </td></tr>
 <tr><td>
 
@@ -790,6 +801,17 @@ Hacknet server related constants
 Hacknet Server formulas
 
 
+</td></tr>
+<tr><td>
+
+[HeartbleedOptions](./bitburner.heartbleedoptions.md)
+
+
+</td><td>
+
+Options to change the behavior of [heartbleed](./bitburner.darknet.heartbleed.md) API.
+
+
 </td></tr>
 <tr><td>
 
@@ -1185,6 +1207,17 @@ Various info about resets
 A server. Not all servers have all of these properties - optional properties are missing on certain servers.
 
 
+</td></tr>
+<tr><td>
+
+[ServerAuthDetails](./bitburner.serverauthdetails.md)
+
+
+</td><td>
+
+Details about a server's authentication schema
+
+
 </td></tr>
 <tr><td>
 
@@ -1803,17 +1836,6 @@ Names of all companies
 
 
 
-</td></tr>
-<tr><td>
-
-[DarknetInstability](./bitburner.darknetinstability.md)
-
-
-</td><td>
-
-Instability of the darknet caused by excessive backdoor-ing of servers.
-
-
 </td></tr>
 <tr><td>
 
@@ -1999,17 +2021,6 @@ Locations of gym
 
 
 
-</td></tr>
-<tr><td>
-
-[HeartbleedOptions](./bitburner.heartbleedoptions.md)
-
-
-</td><td>
-
-Options to change the behavior of [heartbleed](./bitburner.darknet.heartbleed.md) API.
-
-
 </td></tr>
 <tr><td>
 
@@ -2165,17 +2176,6 @@ Use React.createElement to make the ReactElement type, see [creating an element
 
 
 
-</td></tr>
-<tr><td>
-
-[ServerAuthDetails](./bitburner.serverauthdetails.md)
-
-
-</td><td>
-
-Details about a server's authentication schema
-
-
 </td></tr>
 <tr><td>
 

markdown/bitburner.serverauthdetails.data.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [data](./bitburner.serverauthdetails.data.md)
+
+## ServerAuthDetails.data property
+
+Data from the passwordHint, if any.
+
+**Signature:**
+
+```typescript
+data: string;
+```

markdown/bitburner.serverauthdetails.hassession.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [hasSession](./bitburner.serverauthdetails.hassession.md)
+
+## ServerAuthDetails.hasSession property
+
+True if the current script has authenticated to this server with the right password using authenticate() or connectToSesssion()
+
+**Signature:**
+
+```typescript
+hasSession: boolean;
+```

markdown/bitburner.serverauthdetails.isconnectedtocurrentserver.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [isConnectedToCurrentServer](./bitburner.serverauthdetails.isconnectedtocurrentserver.md)
+
+## ServerAuthDetails.isConnectedToCurrentServer property
+
+True if the server is directly connected to the current server
+
+**Signature:**
+
+```typescript
+isConnectedToCurrentServer: boolean;
+```

markdown/bitburner.serverauthdetails.logtrafficinterval.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [logTrafficInterval](./bitburner.serverauthdetails.logtrafficinterval.md)
+
+## ServerAuthDetails.logTrafficInterval property
+
+The frequency (in seconds) of the server adding its own messages to its logs, visible with heartBleed().
+
+**Signature:**
+
+```typescript
+logTrafficInterval: number;
+```

markdown/bitburner.serverauthdetails.md

@@ -2,21 +2,190 @@
 
 [Home](./index.md) > [bitburner](./bitburner.md) > [ServerAuthDetails](./bitburner.serverauthdetails.md)
 
-## ServerAuthDetails type
+## ServerAuthDetails interface
 
 Details about a server's authentication schema
 
 **Signature:**
 
 ```typescript
-type ServerAuthDetails = {
-  isConnectedToCurrentServer: boolean;
-  hasSession: boolean;
-  modelId: string;
-  passwordHint: string;
-  data: string;
-  logTrafficInterval: number;
-  passwordLength: number;
-  passwordFormat: "numeric" | "alphabetic" | "alphanumeric" | "ASCII" | "unicode";
-};
+interface ServerAuthDetails 
 ```
+
+## Properties
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[data](./bitburner.serverauthdetails.data.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Data from the passwordHint, if any.
+
+
+</td></tr>
+<tr><td>
+
+[hasSession](./bitburner.serverauthdetails.hassession.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+True if the current script has authenticated to this server with the right password using authenticate() or connectToSesssion()
+
+
+</td></tr>
+<tr><td>
+
+[isConnectedToCurrentServer](./bitburner.serverauthdetails.isconnectedtocurrentserver.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+True if the server is directly connected to the current server
+
+
+</td></tr>
+<tr><td>
+
+[logTrafficInterval](./bitburner.serverauthdetails.logtrafficinterval.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The frequency (in seconds) of the server adding its own messages to its logs, visible with heartBleed().
+
+
+</td></tr>
+<tr><td>
+
+[modelId](./bitburner.serverauthdetails.modelid.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The model ID of the server. Similar models share vulnerabilities.
+
+
+</td></tr>
+<tr><td>
+
+[passwordFormat](./bitburner.serverauthdetails.passwordformat.md)
+
+
+</td><td>
+
+
+</td><td>
+
+"numeric" \| "alphabetic" \| "alphanumeric" \| "ASCII" \| "unicode"
+
+
+</td><td>
+
+The character set used in the password
+
+
+</td></tr>
+<tr><td>
+
+[passwordHint](./bitburner.serverauthdetails.passwordhint.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Static password reminder text set for this server.
+
+
+</td></tr>
+<tr><td>
+
+[passwordLength](./bitburner.serverauthdetails.passwordlength.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+The number of characters in the password
+
+
+</td></tr>
+</tbody></table>
+

markdown/bitburner.serverauthdetails.modelid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [modelId](./bitburner.serverauthdetails.modelid.md)
+
+## ServerAuthDetails.modelId property
+
+The model ID of the server. Similar models share vulnerabilities.
+
+**Signature:**
+
+```typescript
+modelId: string;
+```

markdown/bitburner.serverauthdetails.passwordformat.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [passwordFormat](./bitburner.serverauthdetails.passwordformat.md)
+
+## ServerAuthDetails.passwordFormat property
+
+The character set used in the password
+
+**Signature:**
+
+```typescript
+passwordFormat: "numeric" | "alphabetic" | "alphanumeric" | "ASCII" | "unicode";
+```

markdown/bitburner.serverauthdetails.passwordhint.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [passwordHint](./bitburner.serverauthdetails.passwordhint.md)
+
+## ServerAuthDetails.passwordHint property
+
+Static password reminder text set for this server.
+
+**Signature:**
+
+```typescript
+passwordHint: string;
+```

markdown/bitburner.serverauthdetails.passwordlength.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [bitburner](./bitburner.md) &gt; [ServerAuthDetails](./bitburner.serverauthdetails.md) &gt; [passwordLength](./bitburner.serverauthdetails.passwordlength.md)
+
+## ServerAuthDetails.passwordLength property
+
+The number of characters in the password
+
+**Signature:**
+
+```typescript
+passwordLength: number;
+```