overwolf.io.listenOnFile

Overwolf APIs / overwolf / overwolf / io / listenOnFile

function listenOnFile(
  id: string,
  path: string,
  options: ListenFileOptions,
  callback: CallbackFunction<ListenOnFileResult>,
): void;

Start listening on file. Stream a file (text files only), line-by-line, from the local filesystem.

Parameters

Parameter	Type	Description
`id`	`string`	listen Id.
`path`	`string`	The target path.
`options`	`ListenFileOptions`	Describes the different options to listen to a file.
`callback`	`CallbackFunction`<`ListenOnFileResult`>	result callback.

void