Giter Club home page Giter Club logo

find-and-read-package-json's Introduction

find-and-read-package-json

Find and read data from a package.json file.

Installation

npm install --save find-and-read-package-json

Usage

import findAndReadPackageJSON from 'find-and-read-package-json';

findAndReadPackageJSON(process.cwd())
  .then(({file, json}) => console.log(file, json))
  .catch(error => console.error(error))
;

API

findAndReadPackageJSON(directory: string, options: Options): Promise<{file: string; json: any}>

Find and read data from a package.json file that exists in the provided directory, or that exists in a parent directory of the provided directory.

Parameters
  • directory: string - Required. The directory we will start looking for a package.json file in.
  • options
    • cache: {[file: string]: any} - Optional. An object shared between calls to findAndReadPackageJSON() to reduce repeated calls to fs .readFile().
    • transform: (json : any) => any Optional. A function to transform the JSON read from a package.json file (to save large chunks of JSON from being cached).

find-and-read-package-json's People

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.