Type Declarations

[jslno]

Here are the type declaration for regedit.
Simply create a regedit.d.ts file and copy & paste this code in there.

declare module 'regedit' {
	type Keys = string | string[]
	type Dictionary<K extends string | symbol | number, V> = { [key in K]: V }

	const OS_ARCH_AGNOSTIC = 'A'
	const OS_ARCH_SPECIFIC = 'S'
	const OS_ARCH_32BIT = '32'
	const OS_ARCH_64BIT = '64'

	type Architecture = (typeof OS_ARCH_AGNOSTIC | typeof OS_ARCH_SPECIFIC | typeof OS_ARCH_32BIT | typeof OS_ARCH_64BIT)
	type ErrResCallback = (err: Error | undefined, res: unknown) => unknown

	export const list = (keys: Keys, callback: ErrResCallback) => unknown
	export const list = (keys: Keys, architecture: Architecture = OS_ARCH_AGNOSTIC, callback?: ErrResCallback) => unknown


	export const setExternalVBSLocation = (newLocation: string) => string


	type ErrCallback = (err: Error | undefined) => unknown

	export const createKey = (keys: Keys, callback: ErrCallback) => undefined
	export const createKey = (keys: Keys, architecture: Architecture = OS_ARCH_AGNOSTIC, callback?: ErrCallback) => undefined


	export const deleteKey = (keys: Keys, callback: ErrCallback) => undefined
	export const deleteKey = (keys: Keys, architecture: Architecture = OS_ARCH_AGNOSTIC, callback?: ErrCallback) => undefined


	export const putValue = (map: Dictionary<string, object>, callback: ErrCallback) => undefined
	export const putValue = (map: Dictionary<string, object>, architecture: Architecture = OS_ARCH_AGNOSTIC, callback?: ErrCallback) => undefined


	export const arch = {
		list: (keys: Keys, callback: ErrResCallback) => undefined,
		list32: (keys: Keys, callback: ErrResCallback) => undefined,
		list64: (keys: Keys, callback: ErrResCallback) => undefined,
		createKey: (keys: Keys, callback: ErrResCallback) => undefined,
		createKey32: (keys: Keys, callback: ErrResCallback) => undefined,
		createKey64: (keys: Keys, callback: ErrResCallback) => undefined,
		deleteKey: (keys: Keys, callback: ErrResCallback) => undefined,
		deleteKey32: (keys: Keys, callback: ErrResCallback) => undefined,
		deleteKey64: (keys: Keys, callback: ErrResCallback) => undefined,
		putValue: (keys: Keys, callback: ErrResCallback) => undefined,
		putValue32: (keys: Keys, callback: ErrResCallback) => undefined,
		putValue64: (keys: Keys, callback: ErrResCallback) => undefined
	}
}

[felixhao28]

I changed "unknown" to more proper typings and added "promisified" namespace.

declare module "regedit" {
    export interface REG_SZ_Value {
        value: string;
        type: "REG_SZ";
    }

    export interface REG_EXPAND_SZ_Value {
        value: string;
        type: "REG_EXPAND_SZ";
    }

    export interface REG_DWORD_Value {
        value: number;
        type: "REG_DWORD";
    }

    export interface REG_QWORD_Value {
        value: number;
        type: "REG_QWORD";
    }

    export interface REG_MULTI_SZ_Value {
        value: string[];
        type: "REG_MULTI_SZ";
    }

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

    export interface REG_DEFAULT_Value {
        value: string;
        type: "REG_DEFAULT";
    }

    export type RegistryItemValue = REG_SZ_Value | REG_EXPAND_SZ_Value | REG_DWORD_Value | REG_QWORD_Value | REG_MULTI_SZ_Value | REG_BINARY_Value | REG_DEFAULT_Value;

    export interface RegistryItem {
        exists: boolean;
        keys: string[];
        values: {
            [name: string]: RegistryItemValue;
        };
    }

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

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

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

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

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

    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;

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

    export function createKey<K extends string>(keys: readonly K[], callback: ErrCallback): void;
    export function createKey<K extends string>(keys: readonly K[], architecture: Architecture, callback?: ErrCallback): void;

    export function deleteKey(keys: readonly string[], callback: ErrCallback): void;
    export function deleteKey(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 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 putValue(map: RegistryItemPutCollection, callback: ErrCallback): void;
        export function putValue32(map: RegistryItemPutCollection, callback: ErrCallback): void;
        export function putValue64(map: RegistryItemPutCollection, callback: ErrCallback): void;
    }

    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 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 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 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 putValue(map: RegistryItemPutCollection): Promise<void>;
            export function putValue32(map: RegistryItemPutCollection): Promise<void>;
            export function putValue64(map: RegistryItemPutCollection): Promise<void>;
        }
    }
}

[kessler]

hey guys, can we make this a permanent thing? can you submit a PR?

[felixhao28]

PR: #90