Skip to content

Commit

Permalink
docs: update typed documentation and API report
Browse files Browse the repository at this point in the history
  • Loading branch information
AlCalzone committed May 15, 2024
1 parent 43c4299 commit 9083392
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/api/driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -939,7 +939,7 @@ interface ZWaveOptions extends ZWaveHostOptions {
region?: RFRegion;
/**
* Whether LR-capable regions should automatically be chosen over their corresponding non-LR regions, e.g. `USA` -> `USA (Long Range)`.
* Whether LR-capable regions should automatically be preferred over their corresponding non-LR regions, e.g. `USA` -> `USA (Long Range)`.
* This also overrides the `rf.region` setting if the desired region is not LR-capable.
*
* Default: true.
Expand Down
6 changes: 6 additions & 0 deletions packages/cc/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -20327,6 +20327,12 @@ export type WrapWithTXReport<T> = [T] extends [Promise<infer U>] ? Promise<WrapW
// @public (undocumented)
export function ZWaveDataRate2DataRate(zdr: ZWaveDataRate_2): DataRate_2;

// Warning: (ae-missing-release-tag) "ZWaveLongRangeCC" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class ZWaveLongRangeCC extends CommandClass {
}

// Warning: (ae-missing-release-tag) "ZWavePlusCC" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
Expand Down
5 changes: 5 additions & 0 deletions packages/core/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1508,6 +1508,11 @@ export const managementCCs: readonly CommandClasses[];
// @public
export const MAX_NODES = 232;

// Warning: (ae-missing-release-tag) "MAX_NODES_LR" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export const MAX_NODES_LR = 4000;

// Warning: (ae-missing-release-tag) "MAX_REPEATERS" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
Expand Down
4 changes: 4 additions & 0 deletions packages/nvmedit/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,10 @@ export interface NVMJSON {
controller: NVMJSONController;
// (undocumented)
format: number;
// Warning: (ae-forgotten-export) The symbol "NVMJSONLRNode" needs to be exported by the entry point index.d.ts
//
// (undocumented)
lrNodes?: Record<number, NVMJSONLRNode>;
// (undocumented)
meta?: NVMMeta;
// (undocumented)
Expand Down
13 changes: 11 additions & 2 deletions packages/zwave-js/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -1311,7 +1311,13 @@ export interface VirtualValueID extends TranslatedValueID_2 {
// @public (undocumented)
export class Zniffer extends TypedEventEmitter<ZnifferEventCallbacks> {
constructor(port: string | ZWaveSerialPortImplementation, options?: ZnifferOptions);
get active(): boolean;
// Warning: (ae-forgotten-export) The symbol "CapturedFrame" needs to be exported by the entry point index.d.ts
get capturedFrames(): Readonly<CapturedFrame>[];
clearCapturedFrames(): void;
get currentFrequency(): number | undefined;
destroy(): Promise<void>;
getCaptureAsZLFBuffer(): Buffer;
// (undocumented)
init(): Promise<void>;
saveCaptureToFile(filePath: string): Promise<void>;
Expand Down Expand Up @@ -1421,6 +1427,7 @@ export class ZWaveController extends TypedEventEmitter<ControllerEventCallbacks>
channel: LongRangeChannel;
supportsAutoChannelSelection: boolean;
}>;
getLongRangeNodes(): Promise<readonly number[]>;
getMaxLongRangePowerlevel(): Promise<number>;
getMulticastGroup(nodeIDs: number[]): VirtualNode;
getNodeByDSK(dsk: Buffer | string): ZWaveNode | undefined;
Expand Down Expand Up @@ -2068,6 +2075,7 @@ export interface ZWaveOptions extends ZWaveHostOptions {
};
rf?: {
region?: RFRegion_2;
preferLRRegion?: boolean;
txPower?: {
powerlevel: number;
measured0dBm: number;
Expand Down Expand Up @@ -2132,11 +2140,12 @@ export * from "@zwave-js/cc";
// src/lib/driver/Driver.ts:5576:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/lib/driver/Driver.ts:5577:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/lib/driver/Driver.ts:5713:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/lib/driver/ZWaveOptions.ts:273:120 - (tsdoc-escape-greater-than) The ">" character should be escaped using a backslash to avoid confusion with an HTML tag
// src/lib/node/Node.ts:913:2 - (ae-missing-getter) The property "associations" has a setter but no getter.
// src/lib/node/Node.ts:1004:2 - (ae-missing-getter) The property "deviceConfigHash" has a setter but no getter.
// src/lib/node/Node.ts:2892:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/lib/zniffer/Zniffer.ts:562:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/lib/zniffer/Zniffer.ts:563:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/lib/zniffer/Zniffer.ts:611:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// src/lib/zniffer/Zniffer.ts:612:5 - (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen

// (No @packageDocumentation comment for this package)

Expand Down

0 comments on commit 9083392

Please sign in to comment.