mirror of
https://github.com/gosticks/DefinitelyTyped.git
synced 2025-10-16 12:05:41 +00:00
30 lines
1.3 KiB
TypeScript
30 lines
1.3 KiB
TypeScript
// Type definitions for fs-readfile-promise 3.0
|
|
// Project: https://github.com/shinnn/fs-readfile-promise
|
|
// Definitions by: Motosugi Murata <https://github.com/mtsg>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference types="node" />
|
|
import { PathLike } from "fs";
|
|
type PathType = PathLike | number;
|
|
type OptionsType = { encoding: string; flag?: string; } | string;
|
|
|
|
export = fsReadFilePromise;
|
|
|
|
/**
|
|
* Asynchronously reads the entire contents of a file.
|
|
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
* If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
* @param options Either the encoding for the result, or an object that contains the encoding and an optional flag.
|
|
* If a flag is not provided, it defaults to `'r'`.
|
|
*/
|
|
declare function fsReadFilePromise(path: PathType, options: OptionsType): Promise<string>;
|
|
|
|
/**
|
|
* Asynchronously reads the entire contents of a file.
|
|
* @param path A path to a file. If a URL is provided, it must use the `file:` protocol.
|
|
* If a file descriptor is provided, the underlying file will _not_ be closed automatically.
|
|
*/
|
|
declare function fsReadFilePromise(path: PathType, options?: null): Promise<Buffer>;
|
|
|
|
declare namespace fsReadFilePromise { }
|