class Playwright::WebSocket
The `WebSocket` class represents websocket connections in the page.
Public Instance Methods
Indicates that the web socket has been closed.
# File lib/playwright_api/web_socket.rb, line 6 def closed? wrap_impl(@impl.closed?) end
Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy value. Will throw an error if the webSocket is closed before the event is fired. Returns the event data value.
# File lib/playwright_api/web_socket.rb, line 17 def expect_event(event, predicate: nil, timeout: nil, &block) wrap_impl(@impl.expect_event(unwrap_impl(event), predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block))) end
– inherited from EventEmitter
– @nodoc
# File lib/playwright_api/web_socket.rb, line 44 def off(event, callback) event_emitter_proxy.off(event, callback) end
– inherited from EventEmitter
– @nodoc
# File lib/playwright_api/web_socket.rb, line 38 def on(event, callback) event_emitter_proxy.on(event, callback) end
– inherited from EventEmitter
– @nodoc
# File lib/playwright_api/web_socket.rb, line 32 def once(event, callback) event_emitter_proxy.once(event, callback) end
Contains the URL of the WebSocket
.
# File lib/playwright_api/web_socket.rb, line 11 def url wrap_impl(@impl.url) end
> NOTE: In most cases, you should use [`method: WebSocket.waitForEvent`].
Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function and waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is fired.
# File lib/playwright_api/web_socket.rb, line 26 def wait_for_event(event, predicate: nil, timeout: nil, &block) wrap_impl(@impl.wait_for_event(unwrap_impl(event), predicate: unwrap_impl(predicate), timeout: unwrap_impl(timeout), &wrap_block_call(block))) end
Private Instance Methods
# File lib/playwright_api/web_socket.rb, line 48 def event_emitter_proxy @event_emitter_proxy ||= EventEmitterProxy.new(self, @impl) end