`FileWatcher.Changed`

WebSocket event schema, payload, and examples

Properties

fullPath

string required

fileName

string required

lines

array

data

object

Schema

The JSON Schema for the event payload, if available.

schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "FileChangeEvent",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "fullPath",
    "fileName"
  ],
  "properties": {
    "fullPath": {
      "type": "string"
    },
    "fileName": {
      "type": "string"
    },
    "lines": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "type": "string"
      }
    },
    "data": {
      "type": [
        "null",
        "object"
      ],
      "additionalProperties": {}
    }
  }
}

JSON Payload

An example JSON payload for the event, automatically generated using JSONSchemaFaker

example.json

{
  "data": null,
  "fileName": "commodo cupidatat",
  "fullPath": "nulla occaecat in qui",
  "lines": [
    "consectetur voluptate deserunt Lorem",
    "consequat exercitation nulla occaecat",
    "in ut sed occaecat enim",
    "quis sit dolor",
    "deserunt elit anim fugiat aliquip"
  ]
}

Client Example

Example code showing how to subscribe to this event using the Streamer.bot WebSocket Client

index.js

// Initialize the Streamer.bot WebSocket Client
const client = new StreamerbotClient();

// Subscribe to "FileWatcher.Changed" events and register a callback
client.on('FileWatcher.Changed', ({ event, data }) => {
  // Code here will run every time the event is received!
  console.log('Received event:', event.source, event.type);
  console.log('Event data:', data);
});