Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix: #103 missing typescript definitions #105

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Fix: #103 missing typescript definitions #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ea65389
Fix: #103 missing typescript definitions
davidgoitia May 23, 2022
b8c7ca2
Missing error collection types
davidgoitia May 23, 2022
9ad8212
fix: typescript definition for deleteValue
davidgoitia Jul 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions errors.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
export interface ErrorWithCode extends Error {
code: number;
description?: string;
}

type Errors = {
[key: number]: ErrorWithCode;
};

declare const errors: Errors;

export default errors;
135 changes: 120 additions & 15 deletions regedit.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import type { Readable } from 'stream';
import type { ErrorWithCode } from './errors';

export interface REG_SZ_Value {
value: string;
type: "REG_SZ";
Expand Down Expand Up @@ -25,7 +28,7 @@ export interface REG_MULTI_SZ_Value {

export interface REG_BINARY_Value {
value: number[];
type: "REG_SZ";
type: "REG_BINARY";
}

export interface REG_DEFAULT_Value {
Expand All @@ -40,36 +43,119 @@ export interface RegistryItem {
keys: string[];
values: {
[name: string]: RegistryItemValue;
['']: REG_DEFAULT_Value;
};
}

export type RegistryStreamItem<T extends readonly string[]> = {
key: T[number];
data: RegistryItem;
}

export type RegistryUnexpandedItem<T extends readonly string[]> = {
key: T[number];
exists: boolean;
value: string;
}

export type RegistryItemCollection<T extends readonly string[], U = { [key in T[number]]: RegistryItem }> = U;

export interface RegistryPutItem {
[name: string]: RegistryItemValue;
['']?: REG_DEFAULT_Value;
}

export type RegistryItemPutCollection = {
[key: string]: RegistryPutItem;
};

export const OS_ARCH_AGNOSTIC = "A";
export const OS_ARCH_SPECIFIC = "S";
export const OS_ARCH_32BIT = "32";
export const OS_ARCH_64BIT = "64";

type Architecture = (typeof OS_ARCH_AGNOSTIC | typeof OS_ARCH_SPECIFIC | typeof OS_ARCH_32BIT | typeof OS_ARCH_64BIT);
type Architecture = "A" | "S" | "32" | "64";
type ErrResCallback<T extends readonly string[]> = (err: Error | undefined, res: RegistryItemCollection<T>) => void;
type ErrResUnexpandedCallback<T extends readonly string[]> = (err: Error | undefined, res: RegistryUnexpandedItem<T>[]) => void;

export interface ReadStream<T> extends Readable {
read(size?: number): T;
unpipe<T extends NodeJS.WritableStream>(destination?: T): this;
unshift(chunk: T): void;
push(chunk: T | null, encoding?: string): boolean;

addListener(event: 'close', listener: () => void): this;
addListener(event: 'data', listener: (chunk: T) => void): this;
addListener(event: 'end', listener: () => void): this;
addListener(event: 'readable', listener: () => void): this;
addListener(event: 'error', listener: (err: Error) => void): this;
addListener(event: string | symbol, listener: (...args: any[]) => void): this;

emit(event: 'close'): boolean;
emit(event: 'data', chunk: T): boolean;
emit(event: 'end'): boolean;
emit(event: 'readable'): boolean;
emit(event: 'error', err: Error): boolean;
emit(event: string | symbol, ...args: any[]): boolean;

on(event: 'close', listener: () => void): this;
on(event: 'data', listener: (chunk: T) => void): this;
on(event: 'end', listener: () => void): this;
on(event: 'readable', listener: () => void): this;
on(event: 'error', listener: (err: Error) => void): this;
on(event: string | symbol, listener: (...args: any[]) => void): this;

once(event: 'close', listener: () => void): this;
once(event: 'data', listener: (chunk: T) => void): this;
once(event: 'end', listener: () => void): this;
once(event: 'readable', listener: () => void): this;
once(event: 'error', listener: (err: Error) => void): this;
once(event: string | symbol, listener: (...args: any[]) => void): this;

prependListener(event: 'close', listener: () => void): this;
prependListener(event: 'data', listener: (chunk: T) => void): this;
prependListener(event: 'end', listener: () => void): this;
prependListener(event: 'readable', listener: () => void): this;
prependListener(event: 'error', listener: (err: Error) => void): this;
prependListener(event: string | symbol, listener: (...args: any[]) => void): this;

prependOnceListener(event: 'close', listener: () => void): this;
prependOnceListener(event: 'data', listener: (chunk: T) => void): this;
prependOnceListener(event: 'end', listener: () => void): this;
prependOnceListener(event: 'readable', listener: () => void): this;
prependOnceListener(event: 'error', listener: (err: Error) => void): this;
prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this;

removeListener(event: 'close', listener: () => void): this;
removeListener(event: 'data', listener: (chunk: T) => void): this;
removeListener(event: 'end', listener: () => void): this;
removeListener(event: 'readable', listener: () => void): this;
removeListener(event: 'error', listener: (err: Error) => void): this;
removeListener(event: string | symbol, listener: (...args: any[]) => void): this;

[Symbol.asyncIterator](): AsyncIterableIterator<T>;
}

export function list<K extends string>(keys: readonly K[]): ReadStream<RegistryStreamItem<typeof keys>>;
export function list<K extends string>(keys: readonly K[], architecture: Architecture): ReadStream<RegistryStreamItem<typeof keys>>;
/**
* @deprecated https://github.com/ironSource/node-regedit#note-about-listing-default-values list with callback api will be deperecated and eventually removed in future versions, take a look at the streaming interface below
*/
export function list<K extends string>(keys: readonly K[], callback: ErrResCallback<typeof keys>): void;
export function list<K extends string>(keys: readonly K[], architecture: Architecture, callback?: ErrResCallback<typeof keys>): void;

export function setExternalVBSLocation(newLocation: string): string;

interface ErrorWithCode extends Error {
code: number;
description: string;
}
/**
* @deprecated https://github.com/ironSource/node-regedit#note-about-listing-default-values list with callback api will be deperecated and eventually removed in future versions, take a look at the streaming interface below
*/
export function list<K extends string>(keys: readonly K[], architecture: Architecture, callback: ErrResCallback<typeof keys>): void;

export function listUnexpandedValues<K extends string>(keys: readonly K[]): ReadStream<RegistryUnexpandedItem<typeof keys>>;
export function listUnexpandedValues<K extends string>(keys: readonly K[], architecture: Architecture): ReadStream<RegistryUnexpandedItem<typeof keys>>;
/**
* @deprecated https://github.com/ironSource/node-regedit#note-about-listing-default-values list with callback api will be deperecated and eventually removed in future versions, take a look at the streaming interface below
*/
export function listUnexpandedValues<K extends string>(keys: readonly K[], callback: ErrResUnexpandedCallback<typeof keys>): void;
/**
* @deprecated https://github.com/ironSource/node-regedit#note-about-listing-default-values list with callback api will be deperecated and eventually removed in future versions, take a look at the streaming interface below
*/
export function listUnexpandedValues<K extends string>(keys: readonly K[], architecture: Architecture, callback: ErrResUnexpandedCallback<typeof keys>): void;

export type FOLDER_FOUND = 'Folder found and set';
export type FOLDER_NOT_FOUND = 'Folder not found';
export function setExternalVBSLocation(newLocation: string): FOLDER_FOUND | FOLDER_NOT_FOUND;

type ErrCallback = (err: ErrorWithCode | undefined) => void;

Expand All @@ -79,19 +165,28 @@ export function createKey<K extends string>(keys: readonly K[], architecture: Ar
export function deleteKey(keys: readonly string[], callback: ErrCallback): void;
export function deleteKey(keys: readonly string[], architecture: Architecture, callback?: ErrCallback): void;

export function deleteValue(keys: readonly string[], callback: ErrCallback): void;
export function deleteValue(keys: readonly string[], architecture: Architecture, callback?: ErrCallback): void;

export function putValue(map: RegistryItemPutCollection, callback: ErrCallback): void;
export function putValue(map: RegistryItemPutCollection, architecture: Architecture, callback?: ErrCallback): void;

export namespace arch {
export function list<K extends string>(keys: readonly K[], callback: ErrResCallback<typeof keys>): void;
export function list32<K extends string>(keys: readonly K[], callback: ErrResCallback<typeof keys>): void;
export function list64<K extends string>(keys: readonly K[], callback: ErrResCallback<typeof keys>): void;
export function listUnexpandedValues<K extends string>(keys: readonly K[], callback: ErrResUnexpandedCallback<typeof keys>): void;
export function listUnexpandedValues32<K extends string>(keys: readonly K[], callback: ErrResUnexpandedCallback<typeof keys>): void;
export function listUnexpandedValues64<K extends string>(keys: readonly K[], callback: ErrResUnexpandedCallback<typeof keys>): void;
export function createKey(keys: readonly string[], callback: ErrCallback): void;
export function createKey32(keys: readonly string[], callback: ErrCallback): void;
export function createKey64(keys: readonly string[], callback: ErrCallback): void;
export function deleteKey(keys: readonly string[], callback: ErrCallback): void;
export function deleteKey32(keys: readonly string[], callback: ErrCallback): void;
export function deleteKey64(keys: readonly string[], callback: ErrCallback): void;
export function deleteValue(keys: readonly string[], callback: ErrCallback): void;
export function deleteValue32(keys: readonly string[], callback: ErrCallback): void;
export function deleteValue64(keys: readonly string[], callback: ErrCallback): void;
export function putValue(map: RegistryItemPutCollection, callback: ErrCallback): void;
export function putValue32(map: RegistryItemPutCollection, callback: ErrCallback): void;
export function putValue64(map: RegistryItemPutCollection, callback: ErrCallback): void;
Expand All @@ -100,23 +195,33 @@ export namespace arch {
export namespace promisified {
export function list<K extends string>(keys: readonly K[]): Promise<RegistryItemCollection<typeof keys>>;
export function list<K extends string>(keys: readonly K[], architecture: Architecture): Promise<RegistryItemCollection<typeof keys>>;
export function listUnexpandedValues<K extends string>(keys: readonly K[]): Promise<RegistryUnexpandedItem<typeof keys>[]>;
export function listUnexpandedValues<K extends string>(keys: readonly K[], architecture: Architecture): Promise<RegistryUnexpandedItem<typeof keys>[]>;
export function createKey(keys: readonly string[]): Promise<void>;
export function createKey(keys: readonly string[], architecture: Architecture): Promise<void>;
export function deleteKey(keys: readonly string[]): Promise<void>;
export function deleteKey(keys: readonly string[], architecture: Architecture): Promise<void>;
export function deleteValue(keys: readonly string[]): Promise<void>;
export function deleteValue(keys: readonly string[], architecture: Architecture): Promise<void>;
export function putValue(map: RegistryItemPutCollection): Promise<void>;
export function putValue(map: RegistryItemPutCollection, architecture: Architecture): Promise<void>;

export namespace arch {
export function list<K extends string>(keys: readonly K[]): Promise<RegistryItemCollection<typeof keys>>;
export function list32<K extends string>(keys: readonly K[]): Promise<RegistryItemCollection<typeof keys>>;
export function list64<K extends string>(keys: readonly K[]): Promise<RegistryItemCollection<typeof keys>>;
export function listUnexpandedValues<K extends string>(keys: readonly K[]): Promise<RegistryUnexpandedItem<typeof keys>[]>;
export function listUnexpandedValues32<K extends string>(keys: readonly K[]): Promise<RegistryUnexpandedItem<typeof keys>[]>;
export function listUnexpandedValues64<K extends string>(keys: readonly K[]): Promise<RegistryUnexpandedItem<typeof keys>[]>;
export function createKey(keys: readonly string[]): Promise<void>;
export function createKey32(keys: readonly string[]): Promise<void>;
export function createKey64(keys: readonly string[]): Promise<void>;
export function deleteKey(keys: readonly string[]): Promise<void>;
export function deleteKey32(keys: readonly string[]): Promise<void>;
export function deleteKey64(keys: readonly string[]): Promise<void>;
export function deleteValue(keys: readonly string[]): Promise<void>;
export function deleteValue32(keys: readonly string[]): Promise<void>;
export function deleteValue64(keys: readonly string[]): Promise<void>;
export function putValue(map: RegistryItemPutCollection): Promise<void>;
export function putValue32(map: RegistryItemPutCollection): Promise<void>;
export function putValue64(map: RegistryItemPutCollection): Promise<void>;
Expand Down