https://github.com/rse/graphql-io-server

GraphQL Network Communication Framework (Server)
https://github.com/rse/graphql-io-server

communication framework graphql network server

Last synced: 1 day ago
JSON representation

GraphQL Network Communication Framework (Server)

• Host: GitHub
• URL: https://github.com/rse/graphql-io-server
• Owner: rse
• Created: 2017-06-18T09:49:35.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-05-08T15:53:45.000Z (over 1 year ago)
• Last Synced: 2025-01-17T20:49:29.578Z (6 days ago)
• Topics: communication, framework, graphql, network, server
• Language: JavaScript
• Homepage: http://graphql-io.com/
• Size: 190 KB
• Stars: 8
• Watchers: 5
• Forks: 2
• 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-Server

=================

GraphQL Network Communication Framework (Server)









About

-----

This is a [GraphQL](http://graphql.org/) network communication framework for

JavaScript servers, running under Node.js.

It is based on the GraphQL engine [GraphQL.js](http://graphql.org/graphql-js/),

the GraphQL schema execution library [GraphQL-Tools](http://dev.apollodata.com/tools/graphql-tools/),

the GraphQL type definition library [GraphQL-Tools-Types](https://github.com/rse/graphql-tools-types),

the GraphQL subscription management library [GraphQL-Tools-Subscribe](https://github.com/rse/graphql-tools-subscribe),

the network communication framework [HAPI](https://hapijs.com),

the WebSocket integration plugin [HAPI-Plugin-WebSocket](https://github.com/rse/hapi-plugin-websocket)

and the GraphiQL integration plugin [HAPI-Plugin-GraphiQL](https://github.com/rse/hapi-plugin-graphiql).

It has be used with the corresponding [GraphQL-IO-Client](https://github.com/rse/graphql-io-client)

network communication framework on the JavaScript client side.

Installation

------------

```shell

$ npm install graphql-io-server

```

Usage

-----

```js

/*  all-in-one  */

import { Server } from "graphql-io"

/*  client-side only  */

import { Server } from "graphql-io-server"

```

See the [TypeScript type definition of the GraphQL-IO-Server API](src/graphql-io.d.ts) for details.

Sample

------

```js

/*  Hello World Server  */

const { Server } = require("graphql-io-server")

const server = new Server({ url: "http://127.0.0.1:12345/api" })

server.at("graphql-resolver", () => ({

    Root: { hello: [ "hello: String", () => "world" ] }

}))

await server.start()

```

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.