Examples and troubleshooting

This page shows JavaScript overrides as needed. Each example contains expected results or failing behavior.

Modify scalar fields

修改端口.js

function main(profile) {
  profile["mixed-port"] = 7890;
  return profile;
}

修改端口 diff.js

function main(profile) {
-  profile["mixed-port"] = 10801; 
+  profile["mixed-port"] = 7890; 
  return profile;
}

Modify according to conditions

条件修改.js

function main(profile) {
  if (profile.mode === "rule") {
    profile["log-level"] = "info";
  }
  return profile;
}

When mode is rule:

log-level: info

When the conditions are not met, the script returns the original object and no diff is generated.

Add object field

添加 DNS 字段.js

function main(profile) {
  if (!profile.dns) profile.dns = {};
  profile.dns.enable = true;
  profile.dns["enhanced-mode"] = "fake-ip";
  return profile;
}

添加 DNS 字段 diff.yaml

dns:
  enable: true
  enhanced-mode: fake-ip

Use `deepMerge` to add rules

添加规则.js

function main(profile) {
  return deepMerge(profile, {
    "+rules": ["DOMAIN-SUFFIX,lan,DIRECT"],
    "rules+": ["DOMAIN-SUFFIX,example.com,PROXY"],
  }, true);
}

添加规则 diff.yaml

rules:
  - DOMAIN-SUFFIX,lan,DIRECT
  - DOMAIN-SUFFIX,old.example,DIRECT
  - DOMAIN-SUFFIX,example.com,PROXY
  - MATCH,PROXY

JavaScript does not automatically move MATCH like YAML does. If the original list didn’t put MATCH at the end, the script won’t fix it for you.

Replace object or array

替换 DNS.js

function main(profile) {
  return deepMerge(profile, {
    "dns!": {
      enable: true,
      "enhanced-mode": "fake-ip",
      nameserver: ["1.1.1.1"],
    },
  }, true);
}

替换 DNS diff.yaml

dns:
  enable: false
  nameserver: 
    - 223.5.5.5
  enable: true
  enhanced-mode: fake-ip
  nameserver: 
    - 1.1.1.1

Filter proxy

过滤代理.js

function main(profile) {
  const proxies = Array.isArray(profile.proxies) ? profile.proxies : [];
  profile.proxies = proxies.filter((item) => {
    const name = String((item && item.name) || "");
    return !name.includes("过期");
  });
  return profile;
}

过滤代理 diff.yaml

proxies:
  - name: 香港节点
  - name: 过期节点

If profile.proxies is not an array, the script uses an empty array and ends up with proxies: [].

Modify naming policy group

修改策略组.js

function main(profile) {
  const groups = Array.isArray(profile["proxy-groups"])
    ? profile["proxy-groups"]
    : [];
  const proxy = groups.find((group) => group && group.name === "PROXY");
  if (proxy) proxy.proxies = ["DIRECT"];
  return profile;
}

修改策略组 diff.yaml

proxy-groups:
  - name: PROXY
    proxies: 
      - AUTO
      - DIRECT

If PROXY is not found, the script will not create a new policy group and will not report an error.

Read remote YAML

远程 YAML.js

async function main(profile) {
  const response = await fetch("http://127.0.0.1:8080/patch.yaml");
  if (!response.ok) return profile;
  return deepMerge(profile, await response.yaml(), true);
}

Remote return:

dns:
  enable: true

Expected diff:

远程 YAML 结果 diff.yaml

dns:
  enable: false
  enable: true

Network failure, HTTPS only support, corrupted YAML content, or incomplete Promise will cause the script to fail.

Read remote JSON

远程 JSON.js

async function main(profile) {
  const response = await fetch("http://127.0.0.1:8080/config.json");
  if (!response.ok) return profile;

  const payload = await response.json();
  if (typeof payload.port === "number") {
    profile["mixed-port"] = payload.port;
  }
  return profile;
}

If payload.port is not a number, the script retains the original mixed-port.

Request header and request body

POST 请求.js

async function main(profile) {
  const response = await fetch("http://127.0.0.1:8080/patch", {
    method: "POST",
    headers: {
      "content-type": "application/json",
      authorization: "Bearer token",
    },
    body: {
      mode: profile.mode,
    },
  });

  if (!response.ok) return profile;
  return deepMerge(profile, await response.yaml(), true);
}

The object request body is converted to a JSON string before being sent.

Logs and Exceptions

记录并抛错.js

function main(profile) {
  console.info("开始处理", profile.mode);
  if (!profile.mode) {
    throw new Error("缺少 mode");
  }
  return profile;
}

On failure:

The current override writes [exception] 脚本执行失败.
Subsequent overwrites will not proceed.
Normal configuration will return script errors and file paths.
Encrypted configuration does not expose configuration content and paths in errors or logs.

Return error value

返回数组.js

function main(profile) {
  return profile.rules;
}

Expected results:

JS override result must be an object

缺少 main.js

const unused = 1;

Expected results:

JS override must define main(profile)

Multiple JavaScript overrides

Files are executed in binding order, with subsequent scripts receiving the return value of the previous script:

第一个脚本.js

function main(profile) {
  profile.port = 2;
  return profile;
}

第二个脚本.js

function main(profile) {
  profile.port = profile.port + 3;
  return profile;
}

JavaScript 覆写链结果 diff.yaml

mixed-port: 1
mixed-port: 5

When the second script lacks main, the function of the first script will not be reused, but will fail directly.

Start here

Guides

Overrides

More

Examples and troubleshooting

Modify scalar fields

Modify according to conditions

Add object field

Use `deepMerge` to add rules

Replace object or array

Filter proxy

Modify naming policy group

Read remote YAML

Read remote JSON

Request header and request body

Logs and Exceptions

Return error value

Multiple JavaScript overrides

​Modify scalar fields

​Modify according to conditions

​Add object field

​Use deepMerge to add rules

​Replace object or array

​Filter proxy

​Modify naming policy group

​Read remote YAML

​Read remote JSON

​Request header and request body

​Logs and Exceptions

​Return error value

​Multiple JavaScript overrides

Modify scalar fields

Modify according to conditions

Add object field

Use `deepMerge` to add rules

Replace object or array

Filter proxy

Modify naming policy group

Read remote YAML

Read remote JSON

Request header and request body

Logs and Exceptions

Return error value

Multiple JavaScript overrides