https://github.com/ikcede/hinge-data-ts-wrapper
Typescript wrapper for exported Hinge data
https://github.com/ikcede/hinge-data-ts-wrapper
data hinge typescript
Last synced: 8 months ago
JSON representation
Typescript wrapper for exported Hinge data
- Host: GitHub
- URL: https://github.com/ikcede/hinge-data-ts-wrapper
- Owner: ikcede
- License: mit
- Created: 2024-03-19T10:14:14.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-19T10:43:13.000Z (about 2 years ago)
- Last Synced: 2025-03-06T17:49:03.975Z (about 1 year ago)
- Topics: data, hinge, typescript
- Language: TypeScript
- Homepage: https://github.com/ikcede/hinge-data-ts-wrapper/wiki
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Hinge Data Typescript Wrapper
==============================
A Typescript wrapper for downloaded Hinge data, which
will read an exported matches.json file and wrap everything
in Typescript classes.
Some included methods:
- Get total sent likes
- Get all matches
- Get all dates (matches with "We Met" set to "Yes")
## Build
Initial setup:
```sh
npm install
```
Compile JS to a build/ directory:
```sh
npm build
```
## Test
Testing is set up through Jest and Typescript-Jest
```sh
npm test
```
## Docs
Docs are generated through typedoc and also available on the
[wiki](https://github.com/ikcede/hinge-data-ts-wrapper/wiki).
```sh
npx typedoc
```
Github wiki style docs
```sh
npx typedoc --plugin typedoc-plugin-markdown --plugin typedoc-github-wiki-theme --out docs src/hinge-wrapper.ts
```