Class BetterCockpitFile

constructor

• new BetterCockpitFile(path: string, opts: FileOpenOptions & {
      dne?: "fail";
      persistStat?: boolean;
  }): BetterCockpitFile

• Improved wrapper of cockpit.file()

  Parameters

  • path: string

    path to file
  • opts: FileOpenOptions & {
        dne?: "fail";
        persistStat?: boolean;
    }

    options, same as cockpit.file() plus:

  Returns BetterCockpitFile

failIfDNE

fileHandle

hookedFileHandle

path

persistStat

Optional stat

close

• close(): void

• Returns void

getStat

• getStat(): Promise<{
      gid?: string;
      permissions?: string;
      uid?: string;
  }>

• Returns Promise<{
      gid?: string;
      permissions?: string;
      uid?: string;
  }>

read

• read(): Promise<string>

• Read contents of file, reject if doesn't exist && opts.dne

  Returns Promise<string>

replace

• replace(content: string): Promise<string>

• Replace contents of file, maintaining file permissions

  Parameters

  • content: string

    New content of file

  Returns Promise<string>

  Resolves with file tag

setStat

• setStat(stat?: {}): Promise<void>

• Parameters

  • stat: {} = {}

  Returns Promise<void>

watch

• watch(callback: FileWatchCallback<string>, opts: {
      read?: boolean;
  }): FileWatchHandle

• Parameters

  • callback: FileWatchCallback<string>
  • opts: {
        read?: boolean;
    }

    • Optional read?: boolean

  Returns FileWatchHandle