Comments (6)
export {}
declare global {
interface WebSocket {
accept(): void;
}
class WebSocketPair {
0: WebSocket;
1: WebSocket;
}
interface ResponseInit {
webSocket?: WebSocket;
}
}
from workers-types.
Any updates?
Why those types are not included in this library?
from workers-types.
the doc is now available at https://developers.cloudflare.com/workers/runtime-apis/websockets
from workers-types.
Any updates?
Why those types are not included in this library?
Try adding a pull request, it might make it faster for them to make changes if all they have to do is review your code.
from workers-types.
export { }
declare global {
interface CloudflareWebsocket {
accept(): unknown;
addEventListener(event: 'close', callbackFunction: (code?: number, reason?: string) => unknown): unknown;
addEventListener(event: 'error', callbackFunction: (e: unknown) => unknown): unknown;
addEventListener(event: 'message', callbackFunction: (event: { data: any }) => unknown): unknown;
/**
* @param code https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent
* @param reason
*/
close(code?: number, reason?: string): unknown;
send(message: string|Uint8Array): unknown;
}
class WebSocketPair {
0: CloudflareWebsocket; // Client
1: CloudflareWebsocket; // Server
}
interface ResponseInit {
webSocket?: CloudflareWebsocket;
}
}
from workers-types.
Warning to anyone else using these types:
Using sepbot's suggestion (#84 (comment)) has the effect of adding accept()
to any pre-existing WebSocket
definition. In most cases, this will be the standard DOM WebSocket
in your code.
This would be fine if Cloudflare Workers actually implemented the complete WebSocket spec, but it doesn't. For example, the readyState
property from the spec is not currently supported.
I suggest using instead something like OwenDelahoy's suggestion (#84 (comment)) will narrowly defines only the features actually supported by CF workers.
from workers-types.
Related Issues (20)
- Missing properties on IncomingRequestCfPropertiesBotManagement HOT 1
- Incorrect D1 types HOT 2
- RequestInit is missing some properties like 'cache' HOT 3
- Generate types from `workerd` RTTI HOT 1
- RFC: Exportable types HOT 7
- Fix `request.cf` types
- Generate exportable version of `workers-types` HOT 1
- add JSDocs documentation in types
- Move overrides to `workerd` C++ source code HOT 1
- Include C++ parameter names in types generated from JSG RTTI HOT 2
- Get type hints on incoming Request object HOT 4
- IncomingRequestCfPropertiesGeographicInformation makes geo property access an error (regression from 3.17.0) HOT 7
- HtmlRewriter ElementHandler methods can only accept strings (not general Content) HOT 1
- (3.18.0) IncomingRequestCfPropertiesGeographicInformation is the wrong type HOT 2
- Class 'Request<ParamKeyType, Data>' incorrectly extends base class 'Body' HOT 1
- `new Request` bad type HOT 8
- addEventListener has a broken type definition HOT 1
- NPM Release @cloudflare/worker-types 4.20221111.0 HOT 2
- Add Symbol.iterator to WebScoketPair HOT 1
- What is Fetcher for? HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from workers-types.