You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
61 lines
2.2 KiB
61 lines
2.2 KiB
5 months ago
|
/// <reference types="bun-types" />
|
||
|
|
import type { WebSocketHandler, ServerWebSocket } from 'bun';
|
||
|
|
import { ConnectionInitMessage } from '../common';
|
||
|
|
import { ServerOptions } from '../server';
|
||
|
|
/**
|
||
|
|
* Convenience export for checking the WebSocket protocol on the request in `Bun.serve`.
|
||
|
|
*/
|
||
|
|
export { handleProtocols } from '../server';
|
||
|
|
/**
|
||
|
|
* The extra that will be put in the `Context`.
|
||
|
|
*
|
||
|
|
* @category Server/bun
|
||
|
|
*/
|
||
|
|
export interface Extra {
|
||
|
|
/**
|
||
|
|
* The actual socket connection between the server and the client.
|
||
|
|
*/
|
||
|
|
readonly socket: ServerWebSocket;
|
||
|
|
}
|
||
|
|
/**
|
||
|
|
* Use the server with [Bun](https://bun.sh/).
|
||
|
|
* This is a basic starter, feel free to copy the code over and adjust it to your needs
|
||
|
|
*
|
||
|
|
* The WebSocket subprotocol is not available on the established socket and therefore
|
||
|
|
* needs to be checked during the request handling.
|
||
|
|
*
|
||
|
|
* Additionally, the keep-alive logic _seems_ to be handled by Bun seeing that
|
||
|
|
* they default [`sendPingsAutomatically` to `true`](https://github.com/oven-sh/bun/blob/6a163cf933542506354dc836bd92693bcae5939b/src/deps/uws.zig#L893).
|
||
|
|
*
|
||
|
|
* ```ts
|
||
|
|
* import { makeHandler, handleProtocols } from 'graphql-ws/lib/use/lib/bun';
|
||
|
|
* import { schema } from './my-schema';
|
||
|
|
*
|
||
|
|
* Bun.serve({
|
||
|
|
* fetch(req, server) {
|
||
|
|
* const [path, _search] = req.url.split('?');
|
||
|
|
* if (!path.endsWith('/graphql')) {
|
||
|
|
* return new Response('Not Found', { status: 404 });
|
||
|
|
* }
|
||
|
|
* if (req.headers.get('upgrade') != 'websocket') {
|
||
|
|
* return new Response('Upgrade Required', { status: 426 });
|
||
|
|
* }
|
||
|
|
* if (!handleProtocols(req.headers.get('sec-websocket-protocol') || '')) {
|
||
|
|
* return new Response('Bad Request', { status: 404 });
|
||
|
|
* }
|
||
|
|
* if (!server.upgrade(req)) {
|
||
|
|
* return new Response('Internal Server Error', { status: 500 });
|
||
|
|
* }
|
||
|
|
* return new Response();
|
||
|
|
* },
|
||
|
|
* websocket: makeHandler({ schema }),
|
||
|
|
* port: 4000,
|
||
|
|
* });
|
||
|
|
*
|
||
|
|
* console.log('Listening to port 4000');
|
||
|
|
* ```
|
||
|
|
*
|
||
|
|
* @category Server/bun
|
||
|
|
*/
|
||
|
|
export declare function makeHandler<P extends ConnectionInitMessage['payload'] = ConnectionInitMessage['payload'], E extends Record<PropertyKey, unknown> = Record<PropertyKey, never>>(options: ServerOptions<P, Extra & Partial<E>>): WebSocketHandler;
|