nx
Version:
54 lines (53 loc) • 2.06 kB
TypeScript
/// <reference types="node" />
import type { JsonParseOptions, JsonSerializeOptions } from './json';
import { PathLike } from 'fs';
export interface JsonReadOptions extends JsonParseOptions {
/**
* mutable field recording whether JSON ends with new line
* @default false
*/
endsWithNewline?: boolean;
}
export interface JsonWriteOptions extends JsonSerializeOptions {
/**
* whether to append new line at the end of JSON file
* @default false
*/
appendNewLine?: boolean;
}
/**
* Reads a JSON file and returns the object the JSON content represents.
*
* @param path A path to a file.
* @param options JSON parse options
* @returns Object the JSON content of the file represents
*/
export declare function readJsonFile<T extends object = any>(path: string, options?: JsonReadOptions): T;
/**
* Serializes the given data to JSON and writes it to a file.
*
* @param path A path to a file.
* @param data data which should be serialized to JSON and written to the file
* @param options JSON serialize options
*/
export declare function writeJsonFile<T extends object = object>(path: string, data: T, options?: JsonWriteOptions): void;
/**
* Check if a directory exists
* @param path Path to directory
*/
export declare function directoryExists(path: PathLike): boolean;
/**
* Check if a file exists.
* @param path Path to file
*/
export declare function fileExists(path: PathLike): boolean;
export declare function createDirectory(path: PathLike): void;
export declare function isRelativePath(path: string): boolean;
/**
* Extracts a file from a given tarball to the specified destination.
* @param tarballPath The path to the tarball from where the file should be extracted.
* @param file The path to the file inside the tarball.
* @param destinationFilePath The destination file path.
* @returns True if the file was extracted successfully, false otherwise.
*/
export declare function extractFileFromTarball(tarballPath: string, file: string, destinationFilePath: string): Promise<string>;