# truffle-conflux-config

> Utility for interacting with truffle-conflux-config.js files

Latest version **0.0.2-alpha.0** (published 2019-09-19) · MIT license · 0 weekly downloads

## Install

```sh
npm install truffle-conflux-config
pnpm add truffle-conflux-config
yarn add truffle-conflux-config
bun add truffle-conflux-config
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: no vulnerabilities; popular repo.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.2-alpha.0 |
| Published | 2019-09-19 |
| First published | 2019-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 16 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13905 |
| Author | Tim Coulter |
| Maintainers | liuis |
| Keywords | ethereum, truffle, config |

## Links

- npm: https://www.npmjs.com/package/truffle-conflux-config
- Repository: https://github.com/trufflesuite/truffle/tree/master/packages/truffle-conflux-config
- Homepage: https://github.com/trufflesuite/truffle/tree/master/packages/truffle-conflux-config#readme
- Issues: https://github.com/trufflesuite/truffle/issues
- npm.io page: https://npm.io/package/truffle-conflux-config

## Dependencies (6)

- [lodash](https://npm.io/package/lodash.md) ^4.17.13
- [find-up](https://npm.io/package/find-up.md) ^2.1.0
- [configstore](https://npm.io/package/configstore.md) ^4.0.0
- [original-require](https://npm.io/package/original-require.md) 1.0.1
- [truffle-conflux-error](https://npm.io/package/truffle-conflux-error.md) 0.0.2-alpha.0
- [truffle-conflux-provider](https://npm.io/package/truffle-conflux-provider.md) 0.0.2-alpha.0

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 0.0.2-alpha.0 (latest) — 2019-09-19

## README

# truffle-conflux-config
Utility for interacting with truffle-conflux-config.js files

### Usage
 ```javascript
const TruffleConfig = require("truffle-conflux-config");
```

#### Instantiate default TruffleConfig object
 ```javascript
const newConfig = TruffleConfig.default();
```

#### Instantiate custom TruffleConfig object
 ```javascript
const customConfig = new TruffleConfig("/truffleDirPath", "/currentWorkingDirPath", networkObj);
```

#### Config.detect()
 ```javascript
// find config file & return new TruffleConfig object with config file settings (cwd)
const truffleConfig = TruffleConfig.detect();

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

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

---
_Source: https://npm.io/package/truffle-conflux-config · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._