# Module: vertx-js/web_socket_frame

## vertx-js/web_socket_frame

Source:
  - web_socket_frame.js, line 3

### Classes

WebSocketFrame

### Methods

#### <static> WebSocketFrame.binaryFrame(data, isFinal) → {WebSocketFrame}

  Create a binary WebSocket frame.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `data` | Buffer | the data for the frame
  `isFinal` | boolean | true if it's the final frame in the WebSocket message

  Source:
    - web_socket_frame.js, line 147

  ##### Returns:

  the frame
  Type
    WebSocketFrame

#### <static> WebSocketFrame.continuationFrame(data, isFinal) → {WebSocketFrame}

  Create a continuation frame

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `data` | Buffer | the data for the frame
  `isFinal` | boolean | true if it's the final frame in the WebSocket message

  Source:
    - web_socket_frame.js, line 177

  ##### Returns:

  the frame
  Type
    WebSocketFrame

#### <static> WebSocketFrame.textFrame(str, isFinal) → {WebSocketFrame}

  Create a text WebSocket frame.

  ##### Parameters:

  Name | Type | Description
  --- | --- | ---
  `str` | string | the string for the frame
  `isFinal` | boolean | true if it's the final frame in the WebSocket message

  Source:
    - web_socket_frame.js, line 162

  ##### Returns:

  the frame
  Type
    WebSocketFrame