• Public
  • Public/Protected
  • All

Interface IFileOptions




Optional filter

filter: (x: any) => boolean

Type declaration

    • (x: any): boolean
    • Parameters

      • x: any

      Returns boolean

Optional filterErrors

filterErrors: boolean

Optional glob

glob: boolean

mark if path is an glob pattern

Optional limit

limit: number

limit size

Optional logger

logger: ILoggerApi

Optional offset

offset: number


Optional outputMode

outputMode: "map" | "only_value" | "embed_nodeId" | "responses"


path: string

if path operation which should be performed on given path

  • link to file is given - reads the content of an existing file
  • link to directory is given - list content of the directory

Optional skipLocal

skipLocal: boolean

Each message will be locally processed (calling getResponse; look in Message). With this flag it can be prevented.

Optional stats

stats: boolean

send stats

Optional tail

tail: number

number of lines to tail

Optional targetIds

targetIds: string[]

used for defining targets to send messages

Optional timeout

timeout: number

Optional unit

unit: "byte" | "line"

limit size

Optional waitIfNoTarget

waitIfNoTarget: boolean

If no selected targets are given then no message will be send to unknown hosts. This can be prevented be this flag. The message will be send to unknown hosts and will wait for response till it arrive or will be timed out.

Generated using TypeDoc