Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rse/graphql-io-client
GraphQL Network Communication Framework (Client)
https://github.com/rse/graphql-io-client
client communication framework graphql network
Last synced: 3 days ago
JSON representation
GraphQL Network Communication Framework (Client)
- Host: GitHub
- URL: https://github.com/rse/graphql-io-client
- Owner: rse
- Created: 2017-06-18T09:49:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-10T05:20:15.000Z (about 1 year ago)
- Last Synced: 2025-01-17T20:49:29.514Z (8 days ago)
- Topics: client, communication, framework, graphql, network
- Language: JavaScript
- Homepage: http://graphql-io.com/
- Size: 152 KB
- Stars: 3
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[GraphQL-IO](https://github.com/rse/graphql-io) |
[GraphQL-IO-Client](https://github.com/rse/graphql-io-client) |
[GraphQL-IO-Server](https://github.com/rse/graphql-io-server)
GraphQL-IO-Client
=================
GraphQL Network Communication Framework (Client)
About
-----
This is a [GraphQL](http://graphql.org/) network communication framework for
JavaScript clients, running under either Node.js or in the Browser.
It is based on the GraphQL engine [GraphQL.js](http://graphql.org/graphql-js/), the
GraphQL client library [Apollo Client](https://github.com/apollographql/apollo-client), its
WebSocket network interface [Apollo Client WS](https://github.com/rse/apollo-client-ws)
and the HTTP client library [Axios](https://github.com/mzabriskie/axios). It has be used
with the corresponding [GraphQL-IO-Server](https://github.com/rse/graphql-io-server)
network communication framework on the JavaScript server side.
Installation
------------
```shell
$ npm install graphql-io-client
```
Usage
-----
```js
/* all-in-one */
import { Client } from "graphql-io"
/* client-side only */
import { Client } from "graphql-io-client"
```
See the [TypeScript type definition of the GraphQL-IO-Client API](src/graphql-io.d.ts) for details.
Sample
------
```js
/* Hello World Client */
const { Client } = require("graphql-io-client")
const client = new Client({ url: "http://127.0.0.1:12345/api" })
await client.connect()
let result = await client.query("{ hello }")
await client.disconnect()
console.log(result.data)
```
For more elaborate samples, check out the [Samples](https://github.com/rse/graphql-io/tree/master/sample/) folder.
License
-------
Copyright (c) 2016-2019 Dr. Ralf S. Engelschall (http://engelschall.com/)
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.