RepositoryCurrent collected state Current
Observed since 20 Oct, 19:31 UTC
No superseded metadata states collected. Unchanged observations do not create new revisions.
Back to packageRELEASE DETAILS
0.3.0
npm3box-shared-cache
The shared cache module that 3box uses to share cache across domains using an iframe
Published4 Aug 2020
Direct dependencies24
Transitive dependenciesNot calculated
README
Current package documentation3box-shared-cache
"The shared cache module that 3box uses to share cache across domains using an iframe
API
To proxy orbitdb storage or ipfs storage
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
Running the server in an 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
Make sure you have the option iframeCache enabled for 3box-js and make sure you define an environment variable CACHE_IFRAME_URL with the iframe server url
To launch the iframe server, execute:
$ npm run example:server:start
The server will run on http://localhost:30001 by default.
Maintainers
Downloads & popularity
Awaiting observationsNo metric observations yet
Download counts and popularity will appear here as the collector receives them.
Declared dependencies 24
Native requirements24 direct targetsNot calculated transitive count
| Package / target | Requirement | Relationship |
|---|---|---|
@babel/runtimeEnvironment{
"local_name": "@babel/runtime",
"alias": false,
"peer_metadata": null
} | ^7.9.2 | runtime |
abstract-leveldownEnvironment{
"local_name": "abstract-leveldown",
"alias": false,
"peer_metadata": null
} | ^6.2.2 | runtime |
datastore-levelEnvironment{
"local_name": "datastore-level",
"alias": false,
"peer_metadata": null
} | ^1.1.0 | runtime |
level-jsEnvironment{
"local_name": "level-js",
"alias": false,
"peer_metadata": null
} | ^4.0.2 | runtime |
levelupEnvironment{
"local_name": "levelup",
"alias": false,
"peer_metadata": null
} | ^4.3.2 | runtime |
orbit-db-storage-adapterEnvironment{
"local_name": "orbit-db-storage-adapter",
"alias": false,
"peer_metadata": null
} | ^0.5.3 | runtime |
postmsg-rpcEnvironment{
"local_name": "postmsg-rpc",
"alias": false,
"peer_metadata": null
} | ^2.4.0 | runtime |
@babel/coreEnvironment{
"local_name": "@babel/core",
"alias": false,
"peer_metadata": null
} | ^7.8.7 | development |
@babel/plugin-transform-runtimeEnvironment{
"local_name": "@babel/plugin-transform-runtime",
"alias": false,
"peer_metadata": null
} | ^7.9.0 | development |
@babel/preset-envEnvironment{
"local_name": "@babel/preset-env",
"alias": false,
"peer_metadata": null
} | ^7.8.7 | development |
@babel/preset-reactEnvironment{
"local_name": "@babel/preset-react",
"alias": false,
"peer_metadata": null
} | ^7.10.1 | development |
babel-loaderEnvironment{
"local_name": "babel-loader",
"alias": false,
"peer_metadata": null
} | ^8.0.6 | development |
expressEnvironment{
"local_name": "express",
"alias": false,
"peer_metadata": null
} | ^4.17.1 | development |
http-serverEnvironment{
"local_name": "http-server",
"alias": false,
"peer_metadata": null
} | ^0.11.1 | development |
ipfsEnvironment{
"local_name": "ipfs",
"alias": false,
"peer_metadata": null
} | ^0.46.0 | development |
ipfs-repoEnvironment{
"local_name": "ipfs-repo",
"alias": false,
"peer_metadata": null
} | ^3.0.3 | development |
jestEnvironment{
"local_name": "jest",
"alias": false,
"peer_metadata": null
} | ^25.1.0 | development |
orbit-dbEnvironment{
"local_name": "orbit-db",
"alias": false,
"peer_metadata": null
} | ^0.24.1 | development |
orbit-db-cacheEnvironment{
"local_name": "orbit-db-cache",
"alias": false,
"peer_metadata": null
} | ^0.3.0 | development |
orbit-db-keystoreEnvironment{
"local_name": "orbit-db-keystore",
"alias": false,
"peer_metadata": null
} | ^0.3.4 | development |
serve-staticEnvironment{
"local_name": "serve-static",
"alias": false,
"peer_metadata": null
} | ^1.14.1 | development |
standardEnvironment{
"local_name": "standard",
"alias": false,
"peer_metadata": null
} | ^14.3.1 | development |
webpackEnvironment{
"local_name": "webpack",
"alias": false,
"peer_metadata": null
} | ^4.42.0 | development |
webpack-cliEnvironment{
"local_name": "webpack-cli",
"alias": false,
"peer_metadata": null
} | ^3.3.11 | development |
Distribution files
1 collectedDistribution 1
Source fileSource distribution
Checksums from source
{
"integrity": "sha512-AkNzAFsJjUwNQ7nbVCOPZpq4/7w+SU8zYPK4nzjJA0C+0DHn3mRrR3DgSa9tEgWEmbE+UmcdKf3Ep5cntT8Gig==",
"shasum": "06322514d5273da3d80947f213939e4dc4fc2f39",
"tarball": "https://registry.npmjs.org/3box-shared-cache/-/3box-shared-cache-0.3.0.tgz",
"fileCount": 18,
"unpackedSize": 29830,
"npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJfKMmMCRA9TVsSAnZWagAAtLQP/juxzhfJgfU4ZXi2r42Y\nbHZOoYWmVjPUKWD6oiTpFUWIKYvxPIBaj2nHybrqwTswBQJGMb/sIWs2Q8DA\ng6g5bHD0TyJnhBJR4EZblclmMndjsDY+s6UBfctRJkpbXQWgjs+XTAT0jVOA\nkZhIYNpXKaWXLc1s3VXtFr0BCLNJuQHqldx8K5rTWj+0Js5wmf2XC26HbylR\n0f8SOXWll1L5HaMomrJWwZi2giYmTMFMN8WdIyO5IggZnxnteKR+EtbjiGeU\nTy5/ayPNrHH9yLAsaGxNYEqI/hQlx3Efl3l43sviarm5yBurjL6D4NwqXNaI\n8jztHMAUeYL7sLcFvBtezsPtmkc+7gd65cfiulzIviTaKIN14OwNTGz4EKxW\neY1LSl18HWB86unZSp5HFb30wEcFnieXWXdDtqr2wrwhBBnz+7I4CRIFjffE\npyfeaW2YCFRSqnyxRQBOkomSzyoulLn5dGvIeff6BnqY1w8LKwKCWS0cghEX\n7AFaCxFs+B3dLNDDNlC1fVEp1NITSrZezsDzdXukfVlmVMHdi7Yqs5SzT1a4\nWcluke6/jRtZdA8gsGPKkn7glR/omvEIXUszRjZ3/NYIWcUFsO8mEAxqujjf\ngT+XzFOu/Mve81/+98JHtCx/0XhMTiZfcgHD9XqS75tZufZnSt7TGlPB/0K3\nDZaJ\r\n=DTIb\r\n-----END PGP SIGNATURE-----\r\n",
"signatures": [
{
"keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
"sig": "MEQCIEPyZTfaCZ0ppehiVZsf2zetTbbKYXcuU618b43zA9poAiB7wfrvkjghYPRof2XDEanmdgude0EJ/SwXmeASPGjP/Q=="
}
]
}Repository
PENDINGMetadata history
Meaningful changesRecord identity
package_version:32bb5f45de045637dcfc4b0868ffeaed10e5cb96d276ffb3e9ce0a27a07904bb