From 4fb87a8ec35c43485472307da0920cef2030e578 Mon Sep 17 00:00:00 2001 From: Z-Wave JS Bot <76957017+zwave-js-bot@users.noreply.github.com> Date: Fri, 22 Sep 2023 10:40:19 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20update=20typed=20documentation=20and=20?= =?UTF-8?q?API=20report=20=F0=9F=A4=96=20(#6255)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Al Calzone --- packages/config/api.md | 21 ++++++++------------- packages/core/api.md | 10 +++++++--- packages/host/api.md | 6 +++--- packages/zwave-js/api.md | 19 ++++++++++--------- 4 files changed, 28 insertions(+), 28 deletions(-) diff --git a/packages/config/api.md b/packages/config/api.md index b121d6a18f51..ebd6418eb9bc 100644 --- a/packages/config/api.md +++ b/packages/config/api.md @@ -492,18 +492,13 @@ export interface DeviceComment { // // @public (undocumented) export class DeviceConfig { - constructor(filename: string, - isEmbedded: boolean, manufacturer: string, manufacturerId: number, label: string, description: string, devices: readonly { + constructor(filename: string, isEmbedded: boolean, manufacturer: string, manufacturerId: number, label: string, description: string, devices: readonly { productType: number; productId: number; - }[], firmwareVersion: FirmwareVersionRange, - preferred: boolean, endpoints?: ReadonlyMap | undefined, associations?: ReadonlyMap | undefined, paramInformation?: ParamInfoMap | undefined, - proprietary?: Record | undefined, - compat?: CompatConfig | undefined, - metadata?: DeviceMetadata | undefined); + }[], firmwareVersion: FirmwareVersionRange, preferred: boolean, endpoints?: ReadonlyMap, associations?: ReadonlyMap, paramInformation?: ParamInfoMap, proprietary?: Record, compat?: CompatConfig, metadata?: DeviceMetadata); // (undocumented) - readonly associations?: ReadonlyMap | undefined; - readonly compat?: CompatConfig | undefined; + readonly associations?: ReadonlyMap; + readonly compat?: CompatConfig; // (undocumented) readonly description: string; // (undocumented) @@ -512,7 +507,7 @@ export class DeviceConfig { productId: number; }[]; // (undocumented) - readonly endpoints?: ReadonlyMap | undefined; + readonly endpoints?: ReadonlyMap; // (undocumented) readonly filename: string; // (undocumented) @@ -533,11 +528,11 @@ export class DeviceConfig { readonly manufacturer: string; // (undocumented) readonly manufacturerId: number; - readonly metadata?: DeviceMetadata | undefined; + readonly metadata?: DeviceMetadata; // (undocumented) - readonly paramInformation?: ParamInfoMap | undefined; + readonly paramInformation?: ParamInfoMap; readonly preferred: boolean; - readonly proprietary?: Record | undefined; + readonly proprietary?: Record; } // Warning: (ae-missing-release-tag) "DeviceConfigIndex" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) diff --git a/packages/core/api.md b/packages/core/api.md index 471cfbb14091..3f4fcb0c3038 100644 --- a/packages/core/api.md +++ b/packages/core/api.md @@ -6,7 +6,6 @@ /// -import { DeepPartial } from '@zwave-js/shared'; import type { ExecutionContext } from 'ava'; import type { Format } from 'logform'; import type { JsonlDB } from '@alcalzone/jsonl-db'; @@ -1221,6 +1220,11 @@ export function isMessagePriority(val: unknown): val is MessagePriority; // @public (undocumented) export function isMissingControllerACK(e: unknown): e is ZWaveError; +// 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; + // 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 @@ -3368,7 +3372,7 @@ export enum ZWaveLibraryTypes { // // @public (undocumented) export class ZWaveLogContainer extends winston.Container { - constructor(config?: DeepPartial); + constructor(config?: Partial); // (undocumented) destroy(): void; // (undocumented) @@ -3378,7 +3382,7 @@ export class ZWaveLogContainer extends winston.Container { isLoglevelVisible(loglevel: string): boolean; shouldLogNode(nodeId: number): boolean; // (undocumented) - updateConfiguration(config: DeepPartial): void; + updateConfiguration(config: Partial): void; } // Warning: (ae-missing-release-tag) "ZWaveLogger" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) diff --git a/packages/host/api.md b/packages/host/api.md index 7e71ebad14db..0f517978fd16 100644 --- a/packages/host/api.md +++ b/packages/host/api.md @@ -53,11 +53,11 @@ export interface FileSystem { // (undocumented) pathExists(path: string): Promise; // (undocumented) - readFile(file: string, encoding: string): Promise; + readFile(file: string, encoding: BufferEncoding): Promise; // (undocumented) writeFile(file: string, data: string | Buffer, options?: { - encoding: string; - } | string): Promise; + encoding: BufferEncoding; + } | BufferEncoding): Promise; } // Warning: (ae-missing-release-tag) "NodeSchedulePollOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) diff --git a/packages/zwave-js/api.md b/packages/zwave-js/api.md index 9fa036364a40..6f27c6359c8d 100644 --- a/packages/zwave-js/api.md +++ b/packages/zwave-js/api.md @@ -42,7 +42,8 @@ import { Duration as Duration_2 } from '@zwave-js/core'; import { DurationUnit } from '@zwave-js/core/safe'; import { EntryControlDataTypes } from '@zwave-js/cc/safe'; import { EntryControlEventTypes } from '@zwave-js/cc/safe'; -import { Expand } from '@zwave-js/shared/safe'; +import { Expand } from '@zwave-js/shared'; +import { Expand as Expand_2 } from '@zwave-js/shared/safe'; import { extractFirmware } from '@zwave-js/core'; import { FileSystem } from '@zwave-js/host/safe'; import type { FileSystem as FileSystem_2 } from '@zwave-js/host'; @@ -318,7 +319,8 @@ export class DeviceClass { export class Driver extends TypedEventEmitter implements ZWaveApplicationHost { // (undocumented) [util.inspect.custom](): string; - constructor(port: string | ZWaveSerialPortImplementation, options?: DeepPartial); + // Warning: (ae-forgotten-export) The symbol "PartialZWaveOptions" needs to be exported by the entry point index.d.ts + constructor(port: string | ZWaveSerialPortImplementation, options?: PartialZWaveOptions); get allNodesReady(): boolean; // (undocumented) readonly cacheDir: string; @@ -427,8 +429,8 @@ export class Driver extends TypedEventEmitter implements Z unregisterRequestHandler(fnType: FunctionType, handler: RequestHandler): void; // (undocumented) unwrapCommands(msg: Message & ICommandClassContainer): void; - updateLogConfig(config: DeepPartial): void; - updateOptions(options: DeepPartial): void; + updateLogConfig(config: Partial): void; + updateOptions(options: EditableZWaveOptions): void; // Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen updateUserAgent(components: Record): void; get userAgent(): string; @@ -463,9 +465,9 @@ export { DurationUnit } // Warning: (ae-missing-release-tag) "EditableZWaveOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export type EditableZWaveOptions = Pick & { +export type EditableZWaveOptions = Expand & { userAgent?: Record; -}; +}>; // Warning: (ae-missing-release-tag) "Endpoint" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // @@ -541,7 +543,7 @@ export { FirmwareFileFormat } // Warning: (ae-missing-release-tag) "FirmwareUpdateDeviceID" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public -export type FirmwareUpdateDeviceID = Expand; @@ -562,7 +564,7 @@ export interface FirmwareUpdateFileInfo { // Warning: (ae-missing-release-tag) "FirmwareUpdateInfo" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export type FirmwareUpdateInfo = Expand; @@ -1255,7 +1257,6 @@ export class ZWaveController extends TypedEventEmitter // (undocumented) get supportedSerialAPISetupCommands(): readonly SerialAPISetupCommand[] | undefined; supportsFeature(feature: ZWaveFeature): MaybeNotKnown; - get supportsSoftReset(): MaybeNotKnown; // (undocumented) get supportsTimers(): MaybeNotKnown; toggleRF(enabled: boolean): Promise;