Skip to content

Latest commit

 

History

History
97 lines (82 loc) · 1.98 KB

README.md

File metadata and controls

97 lines (82 loc) · 1.98 KB

hosts-group

以组方式管理hosts文件。

Usage

npm install hosts-group
var hosts = require('hosts-group');
/**
*@description 设置一个host
*@param domain [String] 域名
        ip  [String] ip
        options [Object]
        {
            groupName: "",//组名,默认defaultGroup
            disabled: true/false,//true-注释 false-启用,默认false
            note: "",//注释,可选
            olddomain: "",//原域名,可选
            oldip: ""//原ip,可选
        }
*/
hosts.set(domain, ip, options);

/**
*@description 删除一个host
*@param domain [String] 域名
        ip [String] ip
        groupName  [String] 组名,默认defaultGroup
*/
hosts.remove(domain, id, groupName);

/**
*@description 添加一个分组
*@param groupName [String] 组名
        note  [String] 注释,可选
*/
hosts.addGroup(groupName, note);

/**
*@description 设置修改分组名
*@param oldName [String] 组名
        newName [String] 组名
*/
hosts.setGroup(oldName, newName);

/**
*@description 删除一个分组
*@param groupName [String] 组名
*/
hosts.removeGroup(groupName);

/**
*@description 将一个host移动到另一个分组
*@param domain [String] 域名 
        ip [String] ip
        groupName [String] 原组名
        target_groupName [String] 目标组名
*/
hosts.move(domain, ip, groupName, target_groupName);

/**
*@description 注释一个host
*@param domain [String] 域名 
        ip [String] ip
        groupName [String] 组名,默认defaultGroup
*/
hosts.disable(domain, ip, groupName);

/**
*@description 启用一个host
*@param domain [String] 域名
        ip [String] ip
        groupName [String] 组名,默认defaultGroup
*/
hosts.active(domain, ip, groupName);

/**
*@description 注释一个组的host
*@param groupName [String] 组名
*/
hosts.disableGroup(groupName);

/**
*@description 启用一个组的host
*@param groupName [String] 组名
*/
hosts.activeGroup(groupName);

License

MIT license