# cross-data
> 跨域数据共享方案
Latest version **1.0.2** (published 2019-05-06) · MIT license · 0 weekly downloads
## Install
```sh
npm install cross-data
pnpm add cross-data
yarn add cross-data
bun add cross-data
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.0.2 |
| Published | 2019-05-06 |
| First published | 2019-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | kdylan |
| Maintainers | kdylan |
| Keywords | cross |
## Links
- npm: https://www.npmjs.com/package/cross-data
- Repository: https://github.com/k-dylan/cross-data
- Homepage: https://github.com/k-dylan/cross-data#readme
- Issues: https://github.com/k-dylan/cross-data/issues
- npm.io page: https://npm.io/package/cross-data
## Recent versions
- 1.0.2 (latest) — 2019-05-06
- 1.0.1 — 2019-05-05
- 1.0.0 — 2019-05-05
## README
# cross-data
跨域数据共享方案,突破浏览器同源限制，共享localStorage数据；
## 安装
```bash
npm install --save cross-data
# or
yarn add cross-data
```
## 实现效果
## 使用方法
1. 创建hub.html
```html
Hub
```
2. 项目中添加client
```javascript
import Client from 'cross-data/dist/client.js';
const client = new Client({
iframeUrl: 'https://test.example.com/hub.html' // hub.html文件的目录
})
// 写数据
client.set(key, value).then(res => {
console.log('操作成功')
})
// 读数据
client.get(key).then(data => {
console.log(data)
})
```
## API介绍
1. new hub() 参数
| 参数名 | 类型 | 说明 | 默认值 |
| ---------- | ------ | ----------- | ---- |
| safeDomain | RegExp | 域名白名单，正则表达式 | /.*/ |
| prefix | String | key前缀 | 空 |
2. client API方法
- set(key, value): 设置数据
- get(key): 获取数据
- remove(key): 删除数据
- clear(): 清空所有数据
> 以上api都返回一个Promise对象
---
_Source: https://npm.io/package/cross-data · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._