simplex-chat 6.5.0-beta.4.1 → 6.5.0-beta.4.3

package/docs/core.Class.ChatAPIError.md

@@ -0,0 +1,205 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / ChatAPIError
+
+# Class: ChatAPIError
+
+Defined in: [src/core.ts:92](../src/core.ts#L92)
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+> **new ChatAPIError**(`message`, `chatError`): `ChatAPIError`
+
+Defined in: [src/core.ts:93](../src/core.ts#L93)
+
+#### Parameters
+
+##### message
+
+`string`
+
+##### chatError
+
+`ChatError` | `undefined`
+
+#### Returns
+
+`ChatAPIError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### chatError
+
+> **chatError**: `ChatError` \| `undefined` = `undefined`
+
+Defined in: [src/core.ts:93](../src/core.ts#L93)
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: [src/core.ts:93](../src/core.ts#L93)
+
+#### Inherited from
+
+`Error.message`
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1076](../node_modules/typescript/lib/lib.es5.d.ts#L1076)
+
+#### Inherited from
+
+`Error.name`
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1078](../node_modules/typescript/lib/lib.es5.d.ts#L1078)
+
+#### Inherited from
+
+`Error.stack`
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: [node\_modules/@types/node/globals.d.ts:67](../node_modules/@types/node/globals.d.ts#L67)
+
+The `Error.stackTraceLimit` property specifies the number of stack frames
+collected by a stack trace (whether generated by `new Error().stack` or
+`Error.captureStackTrace(obj)`).
+
+The default value is `10` but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured _after_ the value has been changed.
+
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
+
+#### Inherited from
+
+`Error.stackTraceLimit`
+
+## Methods
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: [node\_modules/@types/node/globals.d.ts:51](../node_modules/@types/node/globals.d.ts#L51)
+
+Creates a `.stack` property on `targetObject`, which when accessed returns
+a string representing the location in the code at which
+`Error.captureStackTrace()` was called.
+
+```js
+const myObject = {};
+Error.captureStackTrace(myObject);
+myObject.stack;  // Similar to `new Error().stack`
+```
+
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
+
+The optional `constructorOpt` argument accepts a function. If given, all frames
+above `constructorOpt`, including `constructorOpt`, will be omitted from the
+generated stack trace.
+
+The `constructorOpt` argument is useful for hiding implementation
+details of error generation from the user. For instance:
+
+```js
+function a() {
+  b();
+}
+
+function b() {
+  c();
+}
+
+function c() {
+  // Create an error without stack trace to avoid calculating the stack trace twice.
+  const { stackTraceLimit } = Error;
+  Error.stackTraceLimit = 0;
+  const error = new Error();
+  Error.stackTraceLimit = stackTraceLimit;
+
+  // Capture the stack trace above function b
+  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
+  throw error;
+}
+
+a();
+```
+
+#### Parameters
+
+##### targetObject
+
+`object`
+
+##### constructorOpt?
+
+`Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Error.captureStackTrace`
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: [node\_modules/@types/node/globals.d.ts:55](../node_modules/@types/node/globals.d.ts#L55)
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+`Error.prepareStackTrace`

package/docs/core.Class.ChatInitError.md

@@ -0,0 +1,205 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / ChatInitError
+
+# Class: ChatInitError
+
+Defined in: [src/core.ts:116](../src/core.ts#L116)
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### Constructor
+
+> **new ChatInitError**(`message`, `dbMigrationError`): `ChatInitError`
+
+Defined in: [src/core.ts:117](../src/core.ts#L117)
+
+#### Parameters
+
+##### message
+
+`string`
+
+##### dbMigrationError
+
+[`DBMigrationError`](core.TypeAlias.DBMigrationError.md)
+
+#### Returns
+
+`ChatInitError`
+
+#### Overrides
+
+`Error.constructor`
+
+## Properties
+
+### dbMigrationError
+
+> **dbMigrationError**: [`DBMigrationError`](core.TypeAlias.DBMigrationError.md)
+
+Defined in: [src/core.ts:117](../src/core.ts#L117)
+
+***
+
+### message
+
+> **message**: `string`
+
+Defined in: [src/core.ts:117](../src/core.ts#L117)
+
+#### Inherited from
+
+`Error.message`
+
+***
+
+### name
+
+> **name**: `string`
+
+Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1076](../node_modules/typescript/lib/lib.es5.d.ts#L1076)
+
+#### Inherited from
+
+`Error.name`
+
+***
+
+### stack?
+
+> `optional` **stack**: `string`
+
+Defined in: [node\_modules/typescript/lib/lib.es5.d.ts:1078](../node_modules/typescript/lib/lib.es5.d.ts#L1078)
+
+#### Inherited from
+
+`Error.stack`
+
+***
+
+### stackTraceLimit
+
+> `static` **stackTraceLimit**: `number`
+
+Defined in: [node\_modules/@types/node/globals.d.ts:67](../node_modules/@types/node/globals.d.ts#L67)
+
+The `Error.stackTraceLimit` property specifies the number of stack frames
+collected by a stack trace (whether generated by `new Error().stack` or
+`Error.captureStackTrace(obj)`).
+
+The default value is `10` but may be set to any valid JavaScript number. Changes
+will affect any stack trace captured _after_ the value has been changed.
+
+If set to a non-number value, or set to a negative number, stack traces will
+not capture any frames.
+
+#### Inherited from
+
+`Error.stackTraceLimit`
+
+## Methods
+
+### captureStackTrace()
+
+> `static` **captureStackTrace**(`targetObject`, `constructorOpt?`): `void`
+
+Defined in: [node\_modules/@types/node/globals.d.ts:51](../node_modules/@types/node/globals.d.ts#L51)
+
+Creates a `.stack` property on `targetObject`, which when accessed returns
+a string representing the location in the code at which
+`Error.captureStackTrace()` was called.
+
+```js
+const myObject = {};
+Error.captureStackTrace(myObject);
+myObject.stack;  // Similar to `new Error().stack`
+```
+
+The first line of the trace will be prefixed with
+`${myObject.name}: ${myObject.message}`.
+
+The optional `constructorOpt` argument accepts a function. If given, all frames
+above `constructorOpt`, including `constructorOpt`, will be omitted from the
+generated stack trace.
+
+The `constructorOpt` argument is useful for hiding implementation
+details of error generation from the user. For instance:
+
+```js
+function a() {
+  b();
+}
+
+function b() {
+  c();
+}
+
+function c() {
+  // Create an error without stack trace to avoid calculating the stack trace twice.
+  const { stackTraceLimit } = Error;
+  Error.stackTraceLimit = 0;
+  const error = new Error();
+  Error.stackTraceLimit = stackTraceLimit;
+
+  // Capture the stack trace above function b
+  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
+  throw error;
+}
+
+a();
+```
+
+#### Parameters
+
+##### targetObject
+
+`object`
+
+##### constructorOpt?
+
+`Function`
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+`Error.captureStackTrace`
+
+***
+
+### prepareStackTrace()
+
+> `static` **prepareStackTrace**(`err`, `stackTraces`): `any`
+
+Defined in: [node\_modules/@types/node/globals.d.ts:55](../node_modules/@types/node/globals.d.ts#L55)
+
+#### Parameters
+
+##### err
+
+`Error`
+
+##### stackTraces
+
+`CallSite`[]
+
+#### Returns
+
+`any`
+
+#### See
+
+https://v8.dev/docs/stack-trace-api#customizing-stack-traces
+
+#### Inherited from
+
+`Error.prepareStackTrace`

package/docs/core.DBMigrationError.Interface.ErrorMigration.md

@@ -0,0 +1,41 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [DBMigrationError](core.Namespace.DBMigrationError.md) / ErrorMigration
+
+# Interface: ErrorMigration
+
+Defined in: [src/core.ts:144](../src/core.ts#L144)
+
+## Extends
+
+- `Interface`
+
+## Properties
+
+### dbFile
+
+> **dbFile**: `string`
+
+Defined in: [src/core.ts:146](../src/core.ts#L146)
+
+***
+
+### migrationError
+
+> **migrationError**: [`MigrationError`](core.TypeAlias.MigrationError.md)
+
+Defined in: [src/core.ts:147](../src/core.ts#L147)
+
+***
+
+### type
+
+> **type**: `"errorMigration"`
+
+Defined in: [src/core.ts:145](../src/core.ts#L145)
+
+#### Overrides
+
+`Interface.type`

package/docs/core.DBMigrationError.Interface.ErrorNotADatabase.md

@@ -0,0 +1,33 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [DBMigrationError](core.Namespace.DBMigrationError.md) / ErrorNotADatabase
+
+# Interface: ErrorNotADatabase
+
+Defined in: [src/core.ts:139](../src/core.ts#L139)
+
+## Extends
+
+- `Interface`
+
+## Properties
+
+### dbFile
+
+> **dbFile**: `string`
+
+Defined in: [src/core.ts:141](../src/core.ts#L141)
+
+***
+
+### type
+
+> **type**: `"errorNotADatabase"`
+
+Defined in: [src/core.ts:140](../src/core.ts#L140)
+
+#### Overrides
+
+`Interface.type`

package/docs/core.DBMigrationError.Interface.ErrorSQL.md

@@ -0,0 +1,41 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [DBMigrationError](core.Namespace.DBMigrationError.md) / ErrorSQL
+
+# Interface: ErrorSQL
+
+Defined in: [src/core.ts:150](../src/core.ts#L150)
+
+## Extends
+
+- `Interface`
+
+## Properties
+
+### dbFile
+
+> **dbFile**: `string`
+
+Defined in: [src/core.ts:152](../src/core.ts#L152)
+
+***
+
+### migrationSQLError
+
+> **migrationSQLError**: `string`
+
+Defined in: [src/core.ts:153](../src/core.ts#L153)
+
+***
+
+### type
+
+> **type**: `"errorSQL"`
+
+Defined in: [src/core.ts:151](../src/core.ts#L151)
+
+#### Overrides
+
+`Interface.type`

package/docs/core.DBMigrationError.Interface.InvalidConfirmation.md

@@ -0,0 +1,25 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [DBMigrationError](core.Namespace.DBMigrationError.md) / InvalidConfirmation
+
+# Interface: InvalidConfirmation
+
+Defined in: [src/core.ts:135](../src/core.ts#L135)
+
+## Extends
+
+- `Interface`
+
+## Properties
+
+### type
+
+> **type**: `"invalidConfirmation"`
+
+Defined in: [src/core.ts:136](../src/core.ts#L136)
+
+#### Overrides
+
+`Interface.type`

package/docs/core.DBMigrationError.TypeAlias.Tag.md

@@ -0,0 +1,11 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / [DBMigrationError](core.Namespace.DBMigrationError.md) / Tag
+
+# Type Alias: Tag
+
+> **Tag** = `"invalidConfirmation"` \| `"errorNotADatabase"` \| `"errorMigration"` \| `"errorSQL"`
+
+Defined in: [src/core.ts:129](../src/core.ts#L129)

package/docs/core.Enumeration.MigrationConfirmation.md

@@ -0,0 +1,43 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / MigrationConfirmation
+
+# Enumeration: MigrationConfirmation
+
+Defined in: [src/core.ts:101](../src/core.ts#L101)
+
+Migration confirmation mode
+
+## Enumeration Members
+
+### Console
+
+> **Console**: `"console"`
+
+Defined in: [src/core.ts:104](../src/core.ts#L104)
+
+***
+
+### Error
+
+> **Error**: `"error"`
+
+Defined in: [src/core.ts:105](../src/core.ts#L105)
+
+***
+
+### YesUp
+
+> **YesUp**: `"yesUp"`
+
+Defined in: [src/core.ts:102](../src/core.ts#L102)
+
+***
+
+### YesUpDown
+
+> **YesUpDown**: `"yesUpDown"`
+
+Defined in: [src/core.ts:103](../src/core.ts#L103)

package/docs/core.Function.chatCloseStore.md

@@ -0,0 +1,23 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / chatCloseStore
+
+# Function: chatCloseStore()
+
+> **chatCloseStore**(`ctrl`): `Promise`\<`void`\>
+
+Defined in: [src/core.ts:17](../src/core.ts#L17)
+
+Close chat store
+
+## Parameters
+
+### ctrl
+
+`bigint`
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/core.Function.chatDecryptFile.md

@@ -0,0 +1,31 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / chatDecryptFile
+
+# Function: chatDecryptFile()
+
+> **chatDecryptFile**(`fromPath`, `__namedParameters`, `toPath`): `Promise`\<`void`\>
+
+Defined in: [src/core.ts:73](../src/core.ts#L73)
+
+Decrypt file
+
+## Parameters
+
+### fromPath
+
+`string`
+
+### \_\_namedParameters
+
+[`CryptoArgs`](core.Interface.CryptoArgs.md)
+
+### toPath
+
+`string`
+
+## Returns
+
+`Promise`\<`void`\>

package/docs/core.Function.chatEncryptFile.md

@@ -0,0 +1,31 @@
+[**simplex-chat**](README.md)
+
+***
+
+[simplex-chat](README.md) / [core](Namespace.core.md) / chatEncryptFile
+
+# Function: chatEncryptFile()
+
+> **chatEncryptFile**(`ctrl`, `fromPath`, `toPath`): `Promise`\<[`CryptoArgs`](core.Interface.CryptoArgs.md)\>
+
+Defined in: [src/core.ts:65](../src/core.ts#L65)
+
+Encrypt file
+
+## Parameters
+
+### ctrl
+
+`bigint`
+
+### fromPath
+
+`string`
+
+### toPath
+
+`string`
+
+## Returns
+
+`Promise`\<[`CryptoArgs`](core.Interface.CryptoArgs.md)\>