docs: update typed documentation and API report

zwave-js · Oct 4, 2023 · 9b66474 · 9b66474
1 parent 05ac6fe
commit 9b66474
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 3 deletions.
diff --git a/packages/core/api.md b/packages/core/api.md
@@ -1218,17 +1218,25 @@ export function isMessagePriority(val: unknown): val is MessagePriority;
 // Warning: (ae-missing-release-tag) "isMissingControllerACK" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export function isMissingControllerACK(e: unknown): e is ZWaveError;
+export function isMissingControllerACK(e: unknown): e is ZWaveError & {
+    code: ZWaveErrorCodes.Controller_Timeout;
+    context: "ACK";
+};
 
 // Warning: (ae-missing-release-tag) "isMissingControllerCallback" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)
-export function isMissingControllerCallback(e: unknown): e is ZWaveError;
+export function isMissingControllerCallback(e: unknown): e is ZWaveError & {
+    code: ZWaveErrorCodes.Controller_Timeout;
+    context: "callback";
+};
 
 // Warning: (ae-missing-release-tag) "isRecoverableZWaveError" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public
-export function isRecoverableZWaveError(e: unknown): e is ZWaveError;
+export function isRecoverableZWaveError(e: unknown): e is ZWaveError & {
+    code: ZWaveErrorCodes.Controller_InterviewRestarted | ZWaveErrorCodes.Controller_NodeRemoved;
+};
 
 // Warning: (ae-missing-release-tag) "isRssiError" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
@@ -2627,6 +2635,14 @@ export enum TransmitStatus {
 // @public
 export function tryParseDSKFromQRCodeString(qr: string): string | undefined;
 
+// Warning: (ae-missing-release-tag) "tryParseParamNumber" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function tryParseParamNumber(str: string): {
+    parameter: number;
+    valueBitMask?: number;
+} | undefined;
+
 // Warning: (ae-missing-release-tag) "TXReport" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public

diff --git a/packages/zwave-js/api.md b/packages/zwave-js/api.md
@@ -1658,6 +1658,7 @@ export interface ZWaveOptions extends ZWaveHostOptions {
     attempts: {
         controller: number;
         sendData: number;
+        sendDataJammed: number;
         nodeInterview: number;
     };
     disableOptimisticValueUpdate?: boolean;
@@ -1710,6 +1711,7 @@ export interface ZWaveOptions extends ZWaveHostOptions {
         sendDataCallback: number;
         report: number;
         nonce: number;
+        retryJammed: number;
         sendToSleep: number;
         refreshValue: number;
         refreshValueAfterTransition: number;