45 KiB
45 KiB
API Report File for "@zwave-js/shared"
Do not edit this file. It is a report generated by API Extractor.
// Warning: (ae-forgotten-export) The symbol "Constructors" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "AllOf" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function AllOf<T extends any[]>(...BaseClasses: Constructors<T>): Constructor<UnionToIntersection<T[number]>>;
// Warning: (ae-missing-release-tag) "AllOrNone" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export type AllOrNone<T extends Record<string, any>> = T | {
[key in keyof T]?: undefined;
};
// Warning: (ae-missing-release-tag) "applyMixin" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function applyMixin(target: Constructor, mixin: Constructor, includeConstructor?: boolean): void;
// Warning: (ae-missing-release-tag) "areUint8ArraysEqual" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function areUint8ArraysEqual(a: Uint8Array, b: Uint8Array): boolean;
// Warning: (ae-missing-release-tag) "assertUint8Array" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function assertUint8Array(value: unknown): asserts value is Uint8Array;
// Warning: (ae-missing-release-tag) "AsyncQueue" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class AsyncQueue<T> implements AsyncIterable<T> {
// (undocumented)
[Symbol.asyncIterator](): AsyncIterator<T>;
abort(): void;
add(...items: T[]): void;
end(): void;
// (undocumented)
get length(): number;
remove(item: T): boolean;
}
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (ae-missing-release-tag) "buffer2hex" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function buffer2hex(buffer: Uint8Array, uppercase?: boolean): string;
// Warning: (ae-missing-release-tag) "Bytes" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export class Bytes extends Uint8Array {
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@zwave-js/shared" does not have an export "constants"
static alloc(size: number, fill?: number): Bytes;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (ae-unresolved-link) The @link reference could not be resolved: The package "@zwave-js/shared" does not have an export "Uint8Array"
static concat(list: readonly (Uint8Array | ArrayLike<number>)[], totalLength?: number): Bytes;
equals(other: Uint8Array): boolean;
// (undocumented)
static from(data: Uint8Array | ArrayBuffer | ArrayLike<number> | Iterable<number>): Bytes;
// Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
// Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
// Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
// Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
// Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
// Warning: (tsdoc-malformed-inline-tag) Expecting a TSDoc tag starting with "{@"
static from(data: string, encoding?: BufferEncoding): Bytes;
// (undocumented)
static from(arrayLike: Iterable<number>, mapfn?: (v: number, k: number) => number, thisArg?: any): Bytes;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
includes(value: number | Bytes, byteOffset?: number): boolean;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readBigInt64BE(offset?: number): bigint;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readBigInt64LE(offset?: number): bigint;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readBigUInt64BE(offset?: number): bigint;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readBigUInt64LE(offset?: number): bigint;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readInt16BE(offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readInt16LE(offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readInt32BE(offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readInt32LE(offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readInt8(offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
readIntBE(offset: number, byteLength: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
readIntLE(offset: number, byteLength: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readUInt16BE(offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readUInt16LE(offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readUInt32BE(offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readUInt32LE(offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
readUInt8(offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
readUIntBE(offset: number, byteLength: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
readUIntLE(offset: number, byteLength: number): number;
// (undocumented)
subarray(start?: number, end?: number): Bytes;
// (undocumented)
toString(encoding?: BufferEncoding): string;
// Warning: (ae-forgotten-export) The symbol "TypedArray" needs to be exported by the entry point index.d.ts
static view(value: TypedArray | ArrayBuffer | DataView): Bytes;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeBigInt64BE(value: bigint, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeBigInt64LE(value: bigint, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeBigUInt64BE(value: bigint, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeBigUInt64LE(value: bigint, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeInt16BE(value: number, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeInt16LE(value: number, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeInt32BE(value: number, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeInt32LE(value: number, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeInt8(value: number, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeIntBE(value: number, offset: number, byteLength: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeIntLE(value: number, offset: number, byteLength: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeUInt16BE(value: number, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeUInt16LE(value: number, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeUInt32BE(value: number, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeUInt32LE(value: number, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-with-invalid-optional-name) The @param should not include a JSDoc-style optional name; it must not be enclosed in '[ ]' brackets.
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeUInt8(value: number, offset?: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeUIntBE(value: number, offset: number, byteLength: number): number;
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@since" is not defined in this configuration
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-undefined-tag) The TSDoc tag "@return" is not defined in this configuration
writeUIntLE(value: number, offset: number, byteLength: number): number;
}
// Warning: (ae-missing-release-tag) "cloneDeep" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function cloneDeep<T>(source: T): T;
// Warning: (ae-missing-release-tag) "compareStrings" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function compareStrings(a: string, b: string): number;
// Warning: (ae-missing-release-tag) "Constructor" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Constructor<T = object> = new (...args: any[]) => T;
// Warning: (ae-missing-release-tag) "copyFilesRecursive" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function copyFilesRecursive(sourceDir: string, targetDir: string, predicate?: (filename: string) => boolean): Promise<void>;
// Warning: (ae-missing-release-tag) "cpp2js" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function cpp2js(str: string): string;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (ae-missing-release-tag) "createThrowingMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function createThrowingMap<K, V>(throwKeyNotFound?: (key: K) => never): ThrowingMap<K, V>;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (ae-missing-release-tag) "createWrappingCounter" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function createWrappingCounter(maxValue: number, randomSeed?: boolean): () => number;
// Warning: (ae-missing-release-tag) "DeepPartial" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type DeepPartial<T> = {
[P in keyof T]+?: DeepPartial<T[P]>;
};
// Warning: (ae-missing-release-tag) "discreteBinarySearch" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function discreteBinarySearch(rangeMin: number, rangeMax: number, executor: (value: number) => boolean | PromiseLike<boolean>): Promise<number | undefined>;
// Warning: (ae-missing-release-tag) "discreteLinearSearch" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function discreteLinearSearch(rangeMin: number, rangeMax: number, executor: (value: number) => boolean | undefined | PromiseLike<boolean | undefined>): Promise<number | undefined>;
// Warning: (ae-missing-release-tag) "enumFilesRecursive" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function enumFilesRecursive(rootDir: string, predicate?: (filename: string) => boolean): Promise<string[]>;
// Warning: (ae-missing-release-tag) "evalOrStatic" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function evalOrStatic<T>(fnOrConst: T, ...args: any[]): ReturnTypeOrStatic<T>;
// Warning: (ae-missing-release-tag) "EventHandler" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type EventHandler = ((arg1: any, arg2: any, arg3: any, arg4: any) => void) | ((arg1: any, arg2: any, arg3: any) => void) | ((arg1: any, arg2: any) => void) | ((arg1: any) => void) | ((...args: any[]) => void);
// Warning: (ae-missing-release-tag) "Expand" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type Expand<T> = T extends object ? T extends infer O ? {
[K in keyof O]: O[K];
} : never : T;
// Warning: (ae-missing-release-tag) "flatMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function flatMap<U, T extends any[]>(array: T[], callbackfn: (value: T, index: number, array: T[]) => U[]): U[];
// Warning: (ae-missing-release-tag) "FnOrStatic" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type FnOrStatic<TArgs extends any[], TReturn> = ((...args: TArgs) => TReturn) | TReturn;
// Warning: (ae-missing-release-tag) "formatDate" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function formatDate(year: number, month: number, day: number): string;
// Warning: (ae-missing-release-tag) "formatId" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function formatId(id: number | string): string;
// Warning: (ae-missing-release-tag) "formatTime" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function formatTime(hour: number, minute: number): string;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (ae-missing-release-tag) "getEnumMemberName" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function getEnumMemberName(enumeration: unknown, value: number): string;
// Warning: (ae-missing-release-tag) "getErrorMessage" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function getErrorMessage(e: unknown, includeStack?: boolean): string;
// Warning: (ae-missing-release-tag) "hexToUint8Array" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function hexToUint8Array(hexString: string): Uint8Array;
// Warning: (ae-missing-release-tag) "IsAny" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type IsAny<T> = 0 extends 1 & T ? true : false;
// Warning: (ae-missing-release-tag) "isDocker" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function isDocker(): boolean;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (ae-missing-release-tag) "isEnumMember" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function isEnumMember(enumeration: unknown, value: number): boolean;
// Warning: (ae-missing-release-tag) "isPrintableASCII" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function isPrintableASCII(text: string): boolean;
// Warning: (ae-missing-release-tag) "isPrintableASCIIWithWhitespace" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function isPrintableASCIIWithWhitespace(text: string): boolean;
// Warning: (ae-missing-release-tag) "isUint8Array" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function isUint8Array(value: unknown): value is Uint8Array;
// Warning: (ae-missing-release-tag) "JSONObject" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type JSONObject = Record<string, any>;
// Warning: (ae-missing-release-tag) "keysOf" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function keysOf<T extends object>(obj: T): (keyof T)[];
// Warning: (ae-missing-release-tag) "mergeDeep" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function mergeDeep(target: Record<string, any> | undefined, source: Record<string, any>, overwrite?: boolean): Record<string, any>;
// Warning: (ae-missing-release-tag) "MethodsNamesOf" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type MethodsNamesOf<T> = OnlyMethods<T>[keyof T];
// Warning: (ae-missing-release-tag) "Mixin" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function Mixin(baseCtors: Constructor[]): (derivedCtor: Constructor) => void;
// Warning: (ae-missing-release-tag) "noop" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function noop(): void;
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (tsdoc-param-tag-missing-hyphen) The @param block should be followed by a parameter name and then a hyphen
// Warning: (ae-missing-release-tag) "num2hex" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function num2hex(val: number | undefined | null, uppercase?: boolean): string;
// Warning: (ae-missing-release-tag) "ObjectKeyMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export class ObjectKeyMap<TKey extends Record<string | number, any>, TValue> {
// (undocumented)
[Symbol.iterator](): IterableIterator<[TKey, TValue]>;
constructor(entries?: [TKey, TValue][], defaultKeyProps?: Partial<TKey>);
// (undocumented)
clear(): void;
// (undocumented)
delete(key: TKey): boolean;
// (undocumented)
entries(): IterableIterator<[TKey, TValue]>;
// (undocumented)
forEach(callbackfn: (value: TValue, key: TKey, map: this) => void): void;
// (undocumented)
get(key: TKey): TValue | undefined;
// (undocumented)
has(key: TKey): boolean;
// (undocumented)
keys(): IterableIterator<TKey>;
// (undocumented)
set(key: TKey, value: TValue): void;
// (undocumented)
get size(): number;
// (undocumented)
values(): IterableIterator<TValue>;
}
// Warning: (ae-missing-release-tag) "OnlyMethods" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type OnlyMethods<T> = {
[K in keyof T]: T[K] extends (...args: any[]) => any ? T[K] : never;
};
// Warning: (ae-missing-release-tag) "padVersion" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function padVersion(version: string): string;
// Warning: (ae-missing-release-tag) "pathExists" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function pathExists(filename: string): Promise<boolean>;
// Warning: (ae-missing-release-tag) "pick" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function pick<T extends Record<any, any>, K extends keyof T>(obj: T, keys: readonly K[]): Pick<T, K>;
// Warning: (ae-missing-release-tag) "pickDeep" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function pickDeep<T = unknown>(object: Record<string, any>, path: string): T;
// Warning: (ae-missing-release-tag) "readJSON" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function readJSON<T = any>(filename: string): Promise<T>;
// Warning: (ae-forgotten-export) The symbol "PickSymbolIterator" needs to be exported by the entry point index.d.ts
// Warning: (ae-missing-release-tag) "ReadonlyObjectKeyMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ReadonlyObjectKeyMap<TKey extends Record<string | number, any>, TValue> = Pick<ObjectKeyMap<TKey, TValue>, "has" | "get" | "entries" | "keys" | "values" | "size"> & PickSymbolIterator<ObjectKeyMap<TKey, TValue>>;
// Warning: (ae-missing-release-tag) "ReadonlyThrowingMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ReadonlyThrowingMap<K, V> = ReadonlyMap<K, V> & {
getOrThrow(key: K): V;
};
// Warning: (ae-missing-release-tag) "ReturnTypeOrStatic" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ReturnTypeOrStatic<T> = T extends (...args: any[]) => infer R ? R : T;
// Warning: (ae-missing-release-tag) "staticExtends" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function staticExtends<T extends new (...args: any[]) => any>(constructor: unknown, base: T): constructor is T;
// Warning: (ae-missing-release-tag) "stringify" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function stringify(arg: unknown, space?: 4 | "\t"): string;
// Warning: (ae-missing-release-tag) "stringToUint8ArrayUTF16BE" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function stringToUint8ArrayUTF16BE(str: string): Uint8Array;
// Warning: (ae-missing-release-tag) "sum" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function sum(values: number[]): number;
// Warning: (ae-missing-release-tag) "throttle" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function throttle<T extends any[]>(fn: (...args: T) => void, intervalMs: number, trailing?: boolean): (...args: T) => void;
// Warning: (ae-missing-release-tag) "ThrowingMap" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type ThrowingMap<K, V> = Map<K, V> & {
getOrThrow(key: K): V;
};
// Warning: (ae-missing-release-tag) "TimedExpectation" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export class TimedExpectation<TResult = void, TPredicate = never> implements PromiseLike<TResult> {
constructor(timeoutMs: number, predicate?: ((input: TPredicate) => boolean) | undefined, timeoutErrorMessage?: string);
// (undocumented)
readonly predicate?: ((input: TPredicate) => boolean) | undefined;
// (undocumented)
resolve(result: TResult): void;
readonly stack: string;
// (undocumented)
then<TResult1 = TResult, TResult2 = never>(onfulfilled?: ((value: TResult) => TResult1 | PromiseLike<TResult1>) | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): PromiseLike<TResult1 | TResult2>;
}
// Warning: (ae-missing-release-tag) "TypedClassDecorator" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type TypedClassDecorator<Class extends abstract new (...args: any) => any> = (target: Class, context: ClassDecoratorContext<Class>) => Class | void;
// Warning: (ae-missing-release-tag) "TypedEventEmitter" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
// Warning: (ae-missing-release-tag) "TypedEventEmitter" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export interface TypedEventEmitter<TEvents extends Record<keyof TEvents, EventHandler>> {
// (undocumented)
emit<TEvent extends keyof TEvents>(event: TEvent, ...args: Parameters<TEvents[TEvent]>): boolean;
// (undocumented)
eventNames(): Array<keyof TEvents>;
// (undocumented)
getMaxListeners(): number;
// (undocumented)
listenerCount<TEvent extends keyof TEvents>(event: TEvent, listener?: TEvents[TEvent]): number;
// (undocumented)
listeners<TEvent extends keyof TEvents>(eventName: TEvent): TEvents[TEvent][];
// (undocumented)
off<TEvent extends keyof TEvents>(event: TEvent, callback: TEvents[TEvent]): this;
// (undocumented)
on<TEvent extends keyof TEvents>(event: TEvent, callback: TEvents[TEvent]): this;
// (undocumented)
once<TEvent extends keyof TEvents>(event: TEvent, callback: TEvents[TEvent]): this;
// (undocumented)
prependListener<TEvent extends keyof TEvents>(event: TEvent, callback: TEvents[TEvent]): this;
// (undocumented)
prependOnceListener<TEvent extends keyof TEvents>(event: TEvent, callback: TEvents[TEvent]): this;
// (undocumented)
rawListeners<TEvent extends keyof TEvents>(eventName: TEvent): TEvents[TEvent][];
// (undocumented)
removeAllListeners(event?: keyof TEvents): this;
// (undocumented)
removeListener<TEvent extends keyof TEvents>(event: TEvent, callback: TEvents[TEvent]): this;
// (undocumented)
setMaxListeners(n: number): this;
}
// @public (undocumented)
export class TypedEventEmitter<TEvents extends Record<keyof TEvents, EventHandler>> {
}
// Warning: (ae-missing-release-tag) "TypedPropertyDecorator" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type TypedPropertyDecorator<TTarget extends object> = <T extends TTarget>(target: T, propertyKey: string | symbol) => void;
// Warning: (ae-missing-release-tag) "uint8ArrayToHex" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function uint8ArrayToHex(array: Uint8Array): string;
// Warning: (ae-missing-release-tag) "uint8ArrayToString" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export function uint8ArrayToString(array: Uint8Array | ArrayBuffer, encoding?: string): string;
// Warning: (ae-missing-release-tag) "uint8ArrayToStringUTF16BE" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export function uint8ArrayToStringUTF16BE(arr: Uint8Array): string;
// Warning: (ae-missing-release-tag) "UnionToIntersection" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export type UnionToIntersection<T> = (T extends any ? (x: T) => any : never) extends (x: infer R) => any ? R : never;
// (No @packageDocumentation comment for this package)