Interface FileHandle<T>

path

close

• close(): void

• Returns void

modify

• modify(callback: ((data: T) => T)): Promise<[T, string]>

• Parameters

  • callback: ((data: T) => T)
    • • (data: T): T

      • Parameters

        • data: T

        Returns T

  Returns Promise<[T, string]>

read

• read(): Promise<T>

• Returns Promise<T>

replace

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

• Parameters

  • content: T

  Returns Promise<string>

watch

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

• Parameters

  • callback: FileWatchCallback<T>
  • Optional options: {
        read?: boolean;
    }

    • Optional read?: boolean

  Returns FileWatchHandle