Marionette JS Client

API Docs for: 1.7.1
Show:

Marionette.CommandStream Class

Defined in: lib/marionette/command-stream.js:7

Command stream accepts a socket or any event emitter that will emit data events

Constructor

Marionette.CommandStream

(
  • socket
)

Defined in lib/marionette/command-stream.js:7

Parameters:

  • socket EventEmitter

    socket instance.

Item Index

Methods

Properties

Methods

send

(
  • data
)

Defined in lib/marionette/command-stream.js:56

Writes a command to the socket. Handles conversion and formatting of object.

Parameters:

  • data Object

    marionette command.

stringify

(
  • command
)
String

Defined in lib/marionette/command-stream.js:43

Parses command into a string to be sent over a tcp socket to marionette.

Parameters:

  • command Object

    marionette command.

Returns:

String:

command as a string.

Properties

commandEvent

String

Defined in lib/marionette/command-stream.js:33

name of the event this class will emit when a response to a command is received.