Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vanessa219/uvstat
📈 B3log 分布式社区的浏览、评论计数组件，欢迎加入下一代社区网络。
https://github.com/vanessa219/uvstat
b3log statistics
Last synced: 9 days ago
JSON representation
📈 B3log 分布式社区的浏览、评论计数组件，欢迎加入下一代社区网络。
- Host: GitHub
- URL: https://github.com/vanessa219/uvstat
- Owner: Vanessa219
- Created: 2020-01-04T15:43:56.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-02T10:56:12.000Z (over 1 year ago)
- Last Synced: 2024-10-23T02:51:27.160Z (15 days ago)
- Topics: b3log, statistics
- Language: TypeScript
- Homepage:
- Size: 880 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## 💡 简介
[uvstat](https://github.com/Vanessa219/uvstat) 📈 B3log 分布式社区的浏览、评论计数组件，欢迎加入下一代社区网络。
## 🛠️ 使用文档
### CommonJS
* 安装依赖
```shell
npm install uvstat --save
```
* 在代码中引入并初始化对象，可参考 [index.js](https://github.com/Vanessa219/uvstat/blob/master/demo/index.js)
```ts
import Uvstat from 'uvstat'
const uvstat = new Uvstat()
uvstat.renderStat()
uvstat.renderCmtStat()
uvstat.getStat(['http://localhost:9219']).then(stats => {
console.log('getStat: ', stats)
})
uvstat.addStat()
```
### HTML script
* 在 HTML 中插入 js
```html
```
### 示例代码
* [CommonJS](https://github.com/Vanessa219/uvstat/blob/master/demo/index.js)
### API
#### options
||说明|默认值|
|---|---|---|
|cache|访问过的页面不再进行统计|true|
|cacheId|localStorage 名称|'uvstat'|
|loading|加载中的 svg|-|
|location|计数 url 配置|-|
|location.hash|是否统计 hash|false|
|location.pathname|是否统计 pathname|true|
|location.search|是否统计 search|false|
|renderName|浏览计数元素中的 data 属性名称|'uvstaturl'|
|renderCmtName|评论计数元素中的 data 属性名称|'uvstatcmt'|
|cmtAPI|评论统计请求地址|'https://ld246.com/apis/vcomment/count'|
|timeout|请求超时 ms|2000|
|url|服务端请求地址|'https://ld246.com/uvstat'|
#### methods
||说明|
|---|---|
|getStat(urls: ICount[], timeout: number = 0)|获取给定 url 的浏览数|
|getCmtStat(cmts: ICount[], timeout: number = 0)|获取给定帖子 id 的评论数|
|addStat()|为当前页面添加计数|
|renderStat()|浏览计数渲染|
|renderCmtStat(after?: (element: HTMLElement, cnt: number) => void)|评论计数渲染|
|clearCache()|清除缓存|
## 欢迎关注 B3log 开源社区微信公众号 `B3log开源`
