https://github.com/hyper63/hyper-client
https://github.com/hyper63/hyper-client
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/hyper63/hyper-client
- Owner: hyper63
- Created: 2021-04-05T15:27:59.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-07-21T15:47:43.000Z (over 4 years ago)
- Last Synced: 2025-02-13T20:48:17.416Z (about 1 year ago)
- Language: JavaScript
- Size: 99.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# README
hyper-client
hyper-client is a client library for the hyper service. This client library gives developers a great developer experience when using the hyper service. Check out the examples!
---
## Table of Contents
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Setup](#setup)
- [Data Service](#data-service)
- [Cache Service](#cache-service)
- [Search Service](#search-service)
- [Storage Service](#storage-service)
- [Queue Service](#queue-service)
## Getting Started
In order to use this client, you will need a hyper connection string, this connection string will consist of a key, secret, server and app. For example, a connection string may look like this:
https://key:secret@cloud.hyper.io/app - this connection string gives the hyper client all of the information it needs in order to successfully connect to the hyper services.
* key/secret pair - secures the connection
* origin - provides the server url
* pathname - provides the hyper app name
The hyper client expects this configuration to be available via the `HYPER` environment variable.
```