Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): add docs for the websocket event #612

Merged
merged 1 commit into from
Jan 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
69 changes: 69 additions & 0 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
- [class: Page](#class-page)
- [class: Request](#class-request)
- [class: Response](#class-response)
- [class: WebSocket](#class-websocket)
- [class: TimeoutError](#class-timeouterror)
- [class: Accessibility](#class-accessibility)
- [class: Coverage](#class-coverage)
Expand Down Expand Up @@ -1643,6 +1644,7 @@ page.removeListener('request', logRequest);
- [event: 'requestfailed'](#event-requestfailed)
- [event: 'requestfinished'](#event-requestfinished)
- [event: 'response'](#event-response)
- [event: 'websocket'](#event-websocket)
- [event: 'workercreated'](#event-workercreated)
- [event: 'workerdestroyed'](#event-workerdestroyed)
- [page.$(selector)](#pageselector)
Expand Down Expand Up @@ -1812,6 +1814,11 @@ Emitted when a request finishes successfully.

Emitted when a [response] is received.

#### event: 'websocket'
- <[WebSocket]> websocket

Emitted when a <[WebSocket]> is opened.

#### event: 'workercreated'
- <[Worker]>

Expand Down Expand Up @@ -3015,6 +3022,67 @@ Contains the status text of the response (e.g. usually an "OK" for a success).

Contains the URL of the response.

### class: WebSocket

The [WebSocket] class represents websocket connections in the page.

<!-- GEN:toc -->
- [event: 'close'](#event-close-1)
- [event: 'error'](#event-error)
- [event: 'messageReceived'](#event-messagereceived)
- [event: 'messageSent'](#event-messagesent)
- [event: 'open'](#event-open)
- [webSocket.requestHeaders()](#websocketrequestheaders)
- [webSocket.responseHeaders()](#websocketresponseheaders)
- [webSocket.status()](#websocketstatus)
- [webSocket.statusText()](#websocketstatustext)
- [webSocket.url()](#websocketurl)
<!-- GEN:stop -->

#### event: 'close'

Fired when the websocket closes.

#### event: 'error'
- <[String]> the error message

Fired when the websocket has an error.

#### event: 'messageReceived'
-<[Buffer]|[String]> data recieved

Fired when the websocket recieves a message.

#### event: 'messageSent'
-<[Buffer]|[String]> data recieved

Fired when the websocket sends a message.

#### event: 'open'

Fired when the websocket opens.

#### webSocket.requestHeaders()
- returns: <[Promise]<[Object]>>

#### webSocket.responseHeaders()
- returns: <[Promise]<[Object]>>

#### webSocket.status()
- returns: <[number]>

Contains the status code of the WebSocket (e.g., 200 for a success).

#### webSocket.statusText()
- returns: <[string]>

Contains the status text of the WebSocket (e.g. usually an "OK" for a success).

#### webSocket.url()
- returns: <[string]>

Contains the URL of the WebSocket.

### class: TimeoutError

* extends: [Error]
Expand Down Expand Up @@ -3748,6 +3816,7 @@ During installation Playwright downloads browser executables, according to revis
[UnixTime]: https://en.wikipedia.org/wiki/Unix_time "Unix Time"
[WebKitBrowser]: #class-webkitbrowser "WebKitBrowser"
[WebKitPlaywright]: #class-webkitplaywright "WebKitPlaywright"
[WebSocket]: #class-websocket "WebSocket"
[Worker]: #class-worker "Worker"
[boolean]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Data_structures#Boolean_type "Boolean"
[function]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function "Function"
Expand Down
2 changes: 1 addition & 1 deletion src/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ export { TimeoutError } from './errors';
export { Frame } from './frames';
export { Keyboard, Mouse } from './input';
export { JSHandle } from './javascript';
export { Request, Response } from './network';
export { Request, Response, WebSocket } from './network';
export { Coverage, FileChooser, Page, Worker } from './page';

export { CRBrowser as ChromiumBrowser } from './chromium/crBrowser';
Expand Down