[go: up one dir, main page]

@terra-money/houston-config
TypeScript icon, indicating that this package has built-in type declarations

0.2.2 • Public • Published

@terra-money/houston-config

Utility for interacting with houston-config.js files

Usage

import HoustonConfig from "@terra-money/houston-config";

Instantiate default HoustonConfig object

const newConfig = HoustonConfig.default();

Instantiate custom HoustonConfig object

const customConfig = new HoustonConfig(
  "/houstonDirPath",
  "/currentWorkingDirPath",
  networkObj
);

Config.detect()

// find config file & return new HoustonConfig object with config file settings (cwd)
const HoustonConfig = HoustonConfig.detect();

// find config file & return new HoustonConfig object from custom working dir
const HoustonConfig = HoustonConfig.detect({ workingDirectory: "./some/Path" });

// find & return new HoustonConfig object from custom named config
const customHoustonConfig = HoustonConfig.detect({}, "./customConfig.js");

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

Apache 2.0

Readme

Keywords

Package Sidebar

Install

npm i @terra-money/houston-config

Weekly Downloads

2

Version

0.2.2

License

MIT

Unpacked Size

27.7 kB

Total Files

10

Last publish

Collaborators

  • terra-engineering
  • simke9445
  • alecande
  • mwmerz
  • terra-devops