https://github.com/hyper63/hyper-ext-counter
A counter extension for hyper connect that increments a count object in hyper-cache
https://github.com/hyper63/hyper-ext-counter
Last synced: about 1 year ago
JSON representation
A counter extension for hyper connect that increments a count object in hyper-cache
- Host: GitHub
- URL: https://github.com/hyper63/hyper-ext-counter
- Owner: hyper63
- License: apache-2.0
- Created: 2022-01-25T13:25:09.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-01-27T22:40:00.000Z (about 4 years ago)
- Last Synced: 2025-01-13T05:41:39.368Z (about 1 year ago)
- Language: TypeScript
- Size: 104 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
⚡️ hyper-ext-counter ⚡️
A hyper-connect extension that increments a counter object in the hyper cache
---
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [CODE OF CONDUCT](#code-of-conduct)
- [LICENSE](#license)
- [CONTRIBUTING](#contributing)
- [ABOUT](#about)
---
## Install
### NodeJS
```sh
npm install hyper-connect
npm install hyper-ext-counter
```
## Deno (using import-map)
```json
{
"imports": {
"hyper-connect": "https://x.nest.land/hyper-connect@VERSION/deno/mod.ts",
"hyper-ext-counter": "https://x.nest.land/hyper-ext-counter@VERSION/deno/mod.ts"
}
}
```
```sh
deno cache --import-map import_map.json mod.ts
```
---
## Usage
```js
import { connect } from 'hyper-connect'
import { counter } from 'hyper-ext-counter'
// create HYPER=[connection string] env variable
const hyper = counter(connect(process.env.HYPER))
// increment counter
console.log(await hyper.ext.counter.inc('count'))
// get current count
console.log(await hyper.ext.counter.get('count'))
// decrement counter
console.log(await hyper.ext.counter.dec('count'))
// reset to zero
console.log(await hyper.ext.counter.reset('count'))
```
## API
> All functions are promises and take a single argument of string and return Promise | Promise
>
> (key: string) => Promise | Promise
| command | description | example |
| ------- | ----------- | ------- |
| inc | increments counter key | `hyper.ext.counter.inc(/* key */ 'count')` |
| dec | decrements counter key | `hyper.ext.counter.dec(/* key */ 'count')` |
| get | reads and returns current count | `hyper.ext.counter.get(/* key */ 'count' )` |
| reset | resets counter to zero | `hyper.ext.counter.get(/* key */ 'count')` |
## Code of Conduct
SEE [CODE_OF_CONDUCT](/CODE_OF_CONDUCT)
## License
SEE [LICENSE](/LICENSE)
## Contributing
All bug reports and pull requests are welcome that are focused on improving the current scope of this project.
## About
⚡️ hyper-ext-counter is an extension module for hyper-connect a client library for the ⚡️ hyper service. To learn more about ⚡️ hyper go to https://hyper.io