npm包 x-callback 使用教程

介绍

x-callback-url是URI scheme的一种，用于在移动设备的应用之间传递信息。此类URL可以通过在应用间传递的参数启动新应用，并且允许被新的应用返回参数。 x-callback是一个npm包，它提供了一种简单的方法来生成和解析x-callback-url链接。

安装

在命令行界面中使用如下命令来安装：

npm install x-callback

使用指南

创建一个x-callback-url链接

-- -------------------- ---- -------
----- - - ----------------------

----- --- - ---
  ------- --------
  ------- -------
  ----------- -
    --- ------
    ----- -----------
  --
  -------- -----------
  --------- ------------------
  ------- ---------------
---

----------------- ----- -------------------------------------------------------------------------------------------------------------------------------------
展开代码

在这个示例中，我们通过调用 x() 函数来创建一个x-callback-url链接。函数的参数是一个对象，包含要创建链接的参数。

参数解释:

• scheme：URL scheme名称。如 myapp
• action：要执行的操作。如 view
• parameters：传递给应用程序的参数。如 {id: '123', name: 'test_item'}
• xSource：应用程序的URL Scheme。如果应用程序已经运行，这个参数可以让x-callback链接返回到它。例如：如果我的应用程序的URL Scheme是“myapp”，我可以将xSource设置为“myapp://”，而不是“myapp://x-callback-url/”，这样在其他应用程序中使用x-callback链接时将享受更高的兼容性。
• xSuccess：URL Scheme，当应用程序成功执行操作时会调用。例如：如果我的应用程序的URL Scheme是 “myapp”，我可以将xSuccess设置为“myapp://success”，这样当操作完成后，应用程序将使用此链接来返回到调用它的其他应用程序。
• xError：URL Scheme，当应用程序执行操作时遇到错误时会调用。例如：如果我的应用程序的URL Scheme是“myapp”，我可以将xError设置为“myapp://error”。

解析一个x-callback-url链接

const parsed = x.parse('myapp://x-callback-url/view?id=123&name=test_item&x-source=myapp%3A%2F%2F&x-success=myapp%3A%2F%2Fsuccess&x-error=myapp%3A%2F%2Ferror');

console.log(parsed);

在这个示例中，x.parse() 函数将解析 x-callback-url 链接，并返回一个包含所有参数的对象，例如：

-- -------------------- ---- -------
-
  ------- --------
  ------- -------
  ----------- -
    --- ------
    ----- -----------
  --
  -------- -----------
  --------- ------------------
  ------- ---------------
-
展开代码

监听x-callback链接并返回结果

const x = require('x-callback');

// 监听需要返回结果的url并返回查询参数为{result: "finished"}
if (x.isCallbackURL('myapp://x-callback-url/view?id=123&name=test_item&x-source=myapp%3A%2F%2F&x-success=myapp%3A%2F%2Fsuccess&x-error=myapp%3A%2F%2Ferror')) {
  return x.respond({
    result: "finished"
  });
}

在这个示例中，如果成功接收到URL，则 x.isCallbackURL() 函数将返回 true。如果应用程序返回了一个查询参数为 {result: "finished"} 的x-callback-url， x.respond() 函数将生成响应链接，并返回到调用它的应用程序。

更多实例

我们可以在以下应用程序中使用 x-callback-url：

• Drafts: https://getdrafts.com/actions/
• Bear: https://bear.app/faq/X-callback-url%20Scheme%20documentation/
• Things: https://culturedcode.com/things/support/articles/2803572/

结论

x-callback是一种广泛使用的方法，用于在移动应用程序之间传递数据。npm 包x-callback使x-callback-url链接的创建和解析变得简单易行，并且能够在应用程序之间交换数据。使用x-callback-url可以大大提高您的应用程序的兼容性和易用性，为用户提供更好的体验。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/89680