docs: update typed documentation and API report 🤖 (#6337)

Co-authored-by: Al Calzone <[email protected]>
zwave-js · Oct 6, 2023 · fce2c26 · fce2c26
1 parent a7e294d
commit fce2c26
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 4 deletions.
diff --git a/packages/config/api.md b/packages/config/api.md
@@ -144,6 +144,8 @@ export class ConditionalCompatConfig implements ConditionalItem<CompatConfig> {
     // (undocumented)
     readonly disableBasicMapping?: boolean;
     // (undocumented)
+    readonly disableCallbackFunctionTypeCheck?: number[];
+    // (undocumented)
     readonly disableStrictEntryControlDataValidation?: boolean;
     // (undocumented)
     readonly disableStrictMeasurementValidation?: boolean;

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/serial/api.md b/packages/serial/api.md
@@ -467,7 +467,7 @@ export class Message {
     getResponseTimeout(): number | undefined;
     hasCallbackId(): boolean;
     // (undocumented)
-    protected host: ZWaveHost;
+    readonly host: ZWaveHost;
     static isComplete(data?: Buffer): boolean;
     isExpectedCallback(msg: Message): boolean;
     isExpectedNodeUpdate(msg: Message): boolean;

diff --git a/packages/testing/api.md b/packages/testing/api.md
@@ -101,6 +101,11 @@ export interface EnergyProductionCCCapabilities {
     };
 }
 
+// Warning: (ae-missing-release-tag) "getDefaultSupportedFunctionTypes" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export function getDefaultSupportedFunctionTypes(): FunctionType[];
+
 // Warning: (ae-missing-release-tag) "LazyMockZWaveFrame" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)

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;