Package detail

input-from-file-json

JoshuaKGoldberg25.9kMIT0.5.4

create input that reads a file as JSON.

readme

input-from-file-json

Bingo input that reads a file as JSON.

🤝 Code of Conduct: Kept 📝 License: MIT 📦 npm version 💪 TypeScript: Strict

npm i input-from-file-json
import { inputFromFileJSON } from "input-from-file-json";

await take(inputFromFileJSON, { filePath: "data.json" });

Options

inputFromFileJSON takes a single argument, filePath, of type string.

It reads the filePath from disk and returns either:

  • Error: If an error was caught reading or parsing the file
  • unknown: The result of running JSON.parse on the file's text contents

See create.bingo > Templates > Concepts > Inputs for more documentation on Inputs.