Path.openSync() method

pathlib-ts > Path > openSync

Path.openSync() method

Open the file with the given mode using the synchronous helper.

Signature:

openSync(mode?: string): fs.ReadStream;

Parameters

Parameter	Type	Description
mode	string	(Optional) CPython-style mode string (for example "r", "wb").

Returns:

fs.ReadStream

A Node fs.ReadStream configured for the provided mode.

Remarks

Mirrors Path.open() but executes synchronously.

Example

Reading a template stream synchronously

import { Path } from "pathlib-ts";

const template = new Path("./templates/email.html");
const stream = template.openSync("r");
stream.pipe(process.stdout);