Options
All
  • Public
  • Public/Protected
  • All
Menu

Read and write from filesystem using promises.

Index

Functions

Const readFileAsync

  • readFileAsync(path: PathLike | number, options?: { encoding?: null; flag?: string } | null): Promise<Buffer>
  • readFileAsync(path: PathLike | number, options: { encoding: BufferEncoding; flag?: string } | string): Promise<string>
  • readFileAsync(path: PathLike | number, options?: (BaseEncodingOptions & { flag?: string }) | string | null): Promise<string | Buffer>
  • Parameters

    • path: PathLike | number
    • Optional options: { encoding?: null; flag?: string } | null

    Returns Promise<Buffer>

  • Parameters

    • path: PathLike | number
    • options: { encoding: BufferEncoding; flag?: string } | string

    Returns Promise<string>

  • Parameters

    • path: PathLike | number
    • Optional options: (BaseEncodingOptions & { flag?: string }) | string | null

    Returns Promise<string | Buffer>

readJSON

  • readJSON<T>(fileName: string): Promise<T>
  • Type parameters

    • T = Record<string, unknown>

    Parameters

    • fileName: string

    Returns Promise<T>

Const writeFileAsync

  • writeFileAsync(path: PathLike | number, data: string | NodeJS.ArrayBufferView, options?: WriteFileOptions): Promise<void>
  • Parameters

    • path: PathLike | number
    • data: string | NodeJS.ArrayBufferView
    • Optional options: WriteFileOptions

    Returns Promise<void>

writeJSON

  • writeJSON(fileName: string, data: any): Promise<void>
  • Parameters

    • fileName: string
    • data: any

    Returns Promise<void>

Generated using TypeDoc