Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileSync

Sychronous file operations. Use with care as they can limit concurrency. Following the conventions of node fs library, they use a "sync" suffix.

Hierarchy

Index

Properties

Methods

Properties

Readonly cache

cache: Record<string, object>

Use to cache arbitrary content associated with this instance. Use for smallish objects that are expensive to compute.

Readonly name

name: string

Return file name, excluding path

property

{string} name

Readonly path

path: string

Return file path, with forward slashes

property

{string} path

Methods

getContentSync

  • getContentSync(encoding?: string): string

  • Return content. Blocks: use inputStream by preference.

    property

    {string} content

    Parameters

    • Optional encoding: string

    Returns string

setContentSync

  • setContentSync(content: string): this

Generated using TypeDoc