3box-shared-cache 中文文档教程

Question

3box-shared-cache

“3box 用于使用 iframe 跨域共享缓存的共享缓存模块

API

代理 orbitdb 存储或 ipfs 存储

const { createOrbitStorageProxy, createIpfsStorageProxy } = require('3box-shared-cache')

const proxiedOrbitDbStorage = createOrbitStorageProxt({ postMessage }) // pass proper postMessage instance, (e.g: iframe.contentWindow.postMessage to communicate with iframe)

// pass proxied orbitdb storage to orbit-db-cache or orbit-db-keystore or directly as a storage layer

const proxiedIpfsStorage = createIpfsStorageProxy({ postMessage }) // pass proper postMessage instance, (e.g: iframe.contentWindow.postMessage to communicate with iframe)

// pass proxied ipfs storage as db key in storageBackendOptions to ipfs repo options

在 iframe 中运行服务器

const { createServer } = require('3box-shared-cache')

const server = createServer({ postMessage: window.parent.postMessage })
server.init() // initialises the server
server.start() // start the server
server.stop() // stop the server

How to use with 3box-js

确保您为 3box-js 启用了选项 iframeCache 并使确保使用 iframe 服务器 url 定义环境变量 CACHE_IFRAME_URL

要启动 iframe 服务器，请执行：

$ npm run example:server:start

默认情况下，服务器将在 http://localhost:30001 上运行。

Maintainers

< href="https://github.com/zachferland">@zachferland