cros-data
Version:
cross domian localstorage
52 lines (49 loc) • 13.6 kB
HTML
<html lang="en-US">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>API | cors-data</title>
<meta name="description" content="一个跨域共享localstorage的库，API支持Promise，支持权限配置">
<link rel="preload" href="/assets/css/0.styles.bd479351.css" as="style"><link rel="preload" href="/assets/js/app.2c7a37c4.js" as="script"><link rel="preload" href="/assets/js/2.10fc1d59.js" as="script"><link rel="preload" href="/assets/js/7.22a7ad20.js" as="script"><link rel="prefetch" href="/assets/js/3.419108df.js"><link rel="prefetch" href="/assets/js/4.c4832647.js"><link rel="prefetch" href="/assets/js/5.c3f4674f.js"><link rel="prefetch" href="/assets/js/6.eb5caba8.js"><link rel="prefetch" href="/assets/js/8.1c9e0161.js">
<link rel="stylesheet" href="/assets/css/0.styles.bd479351.css">
</head>
<body>
<div id="app" data-server-rendered="true"><div class="theme-container"><header class="navbar"><div class="sidebar-button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" role="img" viewBox="0 0 448 512" class="icon"><path fill="currentColor" d="M436 124H12c-6.627 0-12-5.373-12-12V80c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12zm0 160H12c-6.627 0-12-5.373-12-12v-32c0-6.627 5.373-12 12-12h424c6.627 0 12 5.373 12 12v32c0 6.627-5.373 12-12 12z"></path></svg></div> <a href="/" class="home-link router-link-active"><!----> <span class="site-name">cors-data</span></a> <div class="links"><div class="search-box"><input aria-label="Search" autocomplete="off" spellcheck="false" value=""> <!----></div> <nav class="nav-links can-hide"><div class="nav-item"><a href="/" class="nav-link">首页</a></div><div class="nav-item"><a href="/guide/" class="nav-link router-link-active">指南</a></div><div class="nav-item"><a href="https://github.com/loujohn/cros-data" target="_blank" rel="noopener noreferrer" class="nav-link external">
Github
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav></div></header> <div class="sidebar-mask"></div> <aside class="sidebar"><nav class="nav-links"><div class="nav-item"><a href="/" class="nav-link">首页</a></div><div class="nav-item"><a href="/guide/" class="nav-link router-link-active">指南</a></div><div class="nav-item"><a href="https://github.com/loujohn/cros-data" target="_blank" rel="noopener noreferrer" class="nav-link external">
Github
<svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15" class="icon outbound"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path> <polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg></a></div> <!----></nav> <ul class="sidebar-links"><li><a href="/guide/" class="sidebar-link">快速上手</a></li><li><a href="/guide/api.html" class="active sidebar-link">API</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/api.html#客户端" class="sidebar-link">客户端</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/api.html#new-client-hub-url" class="sidebar-link">new Client(hub_url)</a></li><li class="sidebar-sub-header"><a href="/guide/api.html#set-key-val" class="sidebar-link">set(key,val)</a></li><li class="sidebar-sub-header"><a href="/guide/api.html#get-key" class="sidebar-link">get(key)</a></li><li class="sidebar-sub-header"><a href="/guide/api.html#del-key" class="sidebar-link">del(key)</a></li><li class="sidebar-sub-header"><a href="/guide/api.html#clear" class="sidebar-link">clear()</a></li></ul></li><li class="sidebar-sub-header"><a href="/guide/api.html#数据中心" class="sidebar-link">数据中心</a><ul class="sidebar-sub-headers"><li class="sidebar-sub-header"><a href="/guide/api.html#new-hub-domain-array" class="sidebar-link">new Hub(domain_Array)</a></li></ul></li></ul></li></ul> </aside> <main class="page"> <div class="theme-default-content content__default"><h1 id="api"><a href="#api" class="header-anchor">#</a> API</h1> <h2 id="客户端"><a href="#客户端" class="header-anchor">#</a> 客户端</h2> <h3 id="new-client-hub-url"><a href="#new-client-hub-url" class="header-anchor">#</a> new Client(hub_url)</h3> <ul><li><p>参数</p> <ul><li>{String} hub_url</li></ul></li> <li><p>返回一个客户端实例</p></li> <li><p>用法</p></li></ul> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Client</span><span class="token punctuation">(</span><span class="token string">"http://localhost:8080/hub.html"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h3 id="set-key-val"><a href="#set-key-val" class="header-anchor">#</a> set(key,val)</h3> <ul><li>参数
<ul><li>{String} key</li> <li>{String} val</li></ul></li> <li>返回一个 Promise</li> <li>用法</li></ul> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Client</span><span class="token punctuation">(</span><span class="token string">"http://localhost:8080/hub.html"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
client<span class="token punctuation">.</span><span class="token function">set</span><span class="token punctuation">(</span><span class="token string">"token"</span><span class="token punctuation">,</span> <span class="token number">123</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">res</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>res<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h3 id="get-key"><a href="#get-key" class="header-anchor">#</a> get(key)</h3> <ul><li>参数
<ul><li>{String} key</li></ul></li> <li>返回一个 Promise</li> <li>用法</li></ul> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Client</span><span class="token punctuation">(</span><span class="token string">"http://localhost:8080/hub.html"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
client<span class="token punctuation">.</span><span class="token function">get</span><span class="token punctuation">(</span><span class="token string">"token"</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">res</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>res<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h3 id="del-key"><a href="#del-key" class="header-anchor">#</a> del(key)</h3> <ul><li>参数
<ul><li>{String} key</li></ul></li> <li>返回一个 Promise</li> <li>用法</li></ul> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Client</span><span class="token punctuation">(</span><span class="token string">"http://localhost:8080/hub.html"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
client<span class="token punctuation">.</span><span class="token function">del</span><span class="token punctuation">(</span><span class="token string">"token"</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">res</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>res<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h3 id="clear"><a href="#clear" class="header-anchor">#</a> clear()</h3> <ul><li>参数</li> <li>返回一个 Promise</li> <li>用法</li></ul> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">const</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Client</span><span class="token punctuation">(</span><span class="token string">"http://localhost:8080/hub.html"</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
client<span class="token punctuation">.</span><span class="token function">del</span><span class="token punctuation">(</span><span class="token string">"token"</span><span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">res</span> <span class="token operator">=></span> <span class="token punctuation">{</span>
console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>res<span class="token punctuation">)</span><span class="token punctuation">;</span>
<span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div><h2 id="数据中心"><a href="#数据中心" class="header-anchor">#</a> 数据中心</h2> <h3 id="new-hub-domain-array"><a href="#new-hub-domain-array" class="header-anchor">#</a> new Hub(domain_Array)</h3> <ul><li>参数
<ul><li>{Array} domain_Array</li></ul></li> <li>返回一个数据中心实例</li> <li>用法
<ul><li>接受一个对象数组，对象包含 origin 和 allow 字段。origin 是一个正则表达式，用于匹配消息来源的 origin ，allow 是一个数组，表示允许操作的权限。</li></ul> <div class="language-javascript extra-class"><pre class="language-javascript"><code><span class="token keyword">let</span> hub <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">crosData<span class="token punctuation">.</span>Hub</span><span class="token punctuation">(</span><span class="token punctuation">[</span>
<span class="token punctuation">{</span>
origin<span class="token punctuation">:</span> <span class="token regex">/.*localhost:1000\d$/</span><span class="token punctuation">,</span>
allow<span class="token punctuation">:</span> <span class="token punctuation">[</span><span class="token string">"get"</span><span class="token punctuation">,</span> <span class="token string">"set"</span><span class="token punctuation">,</span> <span class="token string">"del"</span><span class="token punctuation">,</span> <span class="token string">"clear"</span><span class="token punctuation">]</span>
<span class="token punctuation">}</span>
<span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span>
</code></pre></div></li></ul></div> <footer class="page-edit"><!----> <!----></footer> <div class="page-nav"><p class="inner"><span class="prev">
←
<a href="/guide/" class="prev router-link-active">快速上手</a></span> <!----></p></div> </main></div><div class="global-ui"></div></div>
<script src="/assets/js/app.2c7a37c4.js" defer></script><script src="/assets/js/2.10fc1d59.js" defer></script><script src="/assets/js/7.22a7ad20.js" defer></script>
</body>
</html>