regedit-helper v1.0.3

RegEditHelper

A simple tool to help handle the registry

Example

const RegistryHelper = require('regedit-helper').default;
const helper = RegistryHelper.new('HKCU\\Software\\HMS')
helper.query('Test2020').values().then(r=>{
  console.log(r);
})

here's the result:

{ 
  "Test2020": { 
     "name": "admin",
     "age" : "22"
  }
}

API

• static RegeditHelper new(namespace) get a Instance of RegeditHelper

  namespace#string: the registry keyPath, the curd keyPath will relative to it

• static boolean create(keyPath) create a registry key path if not exists

  keyPath#string: the registry full keyPath

• boolean insert(valueObject, keyPath = '') to insert value to the registry

  values#object: a simple js object, and it contains object types, which contains properties type,value

  const valueObject = {
    name:{
        type:'REG_SZ',
        value:'admin'
    }
  }

  keyPath#string: the registry keyPath relative to its namespace

• boolean insertValues(values, keyPath = '', type = RegeditHelper.REG_SZ) to insert value to the registry

  values#object: a simple js object, and it contains only primitive types

    const values = {
         name: 'REG_SZ',
         age: 22,
    }

  keyPath#string: the registry keyPath relative to its namespace

  type#string: the registry type, default REG_SZ

• boolean update(values, keyPath = '', type= RegeditHelper.REG_SZ) update value to the registry, its parameter the same to insertValues

• boolean remove(keys: string | string[] = [], values: string | string[] = []) remove the registry key

  keyPath#string|string[]: the registry keyPath relative to its namespace, default []

  values#string|string[]: the registry leaf keys, default []

  When only the first parameter is passed, the current key and all its child node key values will be removed. The second parameter is used to control the specific attribute key value of the current node    

• this query(keyPath = '', type = '', rec = true) query values from the registry

  keyPath#string: the registry keyPath relative to its namespace, default ''

  type#string: the registry type, default REG_SZ

  rec#boolean: is recursive query required, default true

• Promise<object> origin() get query origin results

• Promise<object> values() get query values results

• Promise<object> one() only get the data of the keyPath, not include its children nodes