Path.readTextSync() method

pathlib-ts > Path > readTextSync

Path.readTextSync() method

Read the file as text using the provided encoding.

Signature:

readTextSync(encoding?: BufferEncoding): string;

Parameters

Parameter	Type	Description
encoding	BufferEncoding	(Optional) Text encoding (defaults to "utf8").

Returns:

string

File contents as a string.

Remarks

Mirrors Path.readText() but executes synchronously.

Example

Loading configuration synchronously

import { Path } from "pathlib-ts";

const config = new Path("./config.json");
const json = JSON.parse(config.readTextSync());