@ionic/utils-fs

Functions

• cacheFileChecksum()
• compilePaths()
• fileToString()
• findBaseDirectory()
• getFileChecksum()
• getFileChecksums()
• getFileTree()
• isExecutableFile()
• pathAccessible()
• pathExecutable()
• pathExists()
• pathReadable()
• pathWritable()
• readdirp()
• readdirSafe()
• statSafe()
• tmpfilepath()
• walk()
• writeStreamToFile()

Classes

• Walker

  • options
  • p
  • paths

Interfaces

• DirectoryNode

  • children
  • parent
  • path
  • type
• GetFileTreeOptions

  • onDirectoryNode
  • onError
  • onFileNode
  • walkerOptions
• ReaddirPOptions

  • filter
  • onError
  • walkerOptions
• RegularFileNode

  • parent
  • path
  • type
• Walker

  • on()
• WalkerItem

  • path
  • stats
• WalkerOptions

  • pathFilter

Enums

• FileType

  • DIRECTORY
  • FILE

Type Aliases

• FileNode

function cacheFileChecksum

cacheFileChecksum: (p: string, checksum?: string) => Promise<void>;

• Store a cache file containing the source file's md5 checksum hash.

  Parameter p

  The file path

  Parameter checksum

  The checksum. If excluded, the checksum is computed

function compilePaths

compilePaths: (filePath: string) => string[];

• Given an absolute system path, compile an array of paths working backwards one directory at a time, always ending in the root directory.

  For example, '/some/dir' => ['/some/dir', '/some', '/']

  Parameter filePath

  Absolute system base path.

function fileToString

fileToString: (filePath: string) => Promise<string>;

function findBaseDirectory

findBaseDirectory: (dir: string, file: string) => Promise<string | undefined>;

• Find the base directory based on the path given and a marker file to look for.

function getFileChecksum

getFileChecksum: (filePath: string) => Promise<string>;

function getFileChecksums

getFileChecksums: (p: string) => Promise<[string, string | undefined]>;

• Return true and cached checksums for a file by its path.

  Cached checksums are stored as .md5 files next to the original file. If the cache file is missing, the cached checksum is undefined.

  Parameter p

  The file path Promise<[true checksum, cached checksum or undefined if cache file missing]>

function getFileTree

getFileTree: <RE = {}, DE = {}>(
    dir: string,
    {
        onError,
        onFileNode,
        onDirectoryNode,
        walkerOptions,
    }?: GetFileTreeOptions<RE, DE>
) => Promise<(RegularFileNode & RE) | (DirectoryNode & DE)>;

• Compile and return a file tree structure.

  This function walks a directory structure recursively, building a nested object structure in memory that represents it. When finished, the root directory node is returned.

  Parameter dir

  The root directory from which to compile the file tree

function isExecutableFile

isExecutableFile: (filePath: string) => Promise<boolean>;

function pathAccessible

pathAccessible: (filePath: string, mode: number) => Promise<boolean>;

function pathExecutable

pathExecutable: (filePath: string) => Promise<boolean>;

function pathExists

pathExists: (filePath: string) => Promise<boolean>;

function pathReadable

pathReadable: (filePath: string) => Promise<boolean>;

function pathWritable

pathWritable: (filePath: string) => Promise<boolean>;

function readdirp

readdirp: (
    dir: string,
    { filter, onError, walkerOptions }?: ReaddirPOptions
) => Promise<string[]>;

function readdirSafe

readdirSafe: (dir: string) => Promise<string[]>;

function statSafe

statSafe: (p: string) => Promise<fs.Stats | undefined>;

function tmpfilepath

tmpfilepath: (prefix?: string) => string;

• Generate a random file path within the computer's temporary directory.

  Parameter prefix

  Optionally provide a filename prefix.

function walk

walk: (p: string, options?: WalkerOptions) => Walker;

function writeStreamToFile

writeStreamToFile: (
    stream: NodeJS.ReadableStream,
    destination: string
) => Promise<any>;

type FileNode

type FileNode = RegularFileNode | DirectoryNode;