# firescript-config

> Config module for Firescript

Latest version **0.6.2** (published 2025-09-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install firescript-config
pnpm add firescript-config
yarn add firescript-config
bun add firescript-config
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

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

## Facts

| | |
|---|---|
| Version | 0.6.2 |
| Published | 2025-09-26 |
| First published | 2020-08-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Andi Heinkelein |
| Maintainers | firetux |
| Keywords | fire, firescript, firemodule, firescript-module, config, conf, settings |

## Links

- npm: https://www.npmjs.com/package/firescript-config
- npm.io page: https://npm.io/package/firescript-config

## Dependencies (1)

- [firescript-runtime](https://npm.io/package/firescript-runtime.md) ^0.3.12

## 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.6.2 (latest) — 2025-09-26
- 0.6.1 — 2025-09-26
- 0.6.0 — 2025-09-26
- 0.5.0 — 2021-08-03
- 0.4.2 — 2021-07-16
- 0.4.1 — 2021-06-06
- 0.4.0 — 2020-12-14
- 0.3.0 — 2020-12-04
- 0.2.4 — 2020-09-26
- 0.2.3 — 2020-09-21
- 0.2.2 — 2020-09-10
- 0.2.1 — 2020-09-03
- 0.2.0 — 2020-08-27
- 0.1.0 — 2020-08-26
- 0.0.0 — 2020-08-24

## README

Firescript config
=================

Firescript config module.

### Usage

```js
import { FirescriptConfig } from 'firescript-config'

const config = new FirescriptConfig({
  srcDir: `${process.cwd()}/src/`,
  destDir: `${process.cwd()}/dist/`
})


```

### Methods

#### loadConfig([*str* filename]) => *obj* config

Load config from a config file

```js
const config = await config.loadConfig()
console.log('Config:', config)
```

**Arguments:** 

| Name:      | Flags:     | Description:            |
| ---------- | ---------- | ----------------------- |
| *filename* | `optional` | Load config from a file |

**Returns:**  

Returns an instance of FirescriptConfig

### Config parameters

| Name:     | Config param: | Default value: | Description:                                                                                                                                                                                                                                    |
| --------- | ------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| srcDir    | `build.src`   | `src/`         | Project source dir                                                                                                                                                                                                                              |
| destDir   | `build.dist`  | `dist/`        | Project destination dir                                                                                                                                                                                                                         |
| copyFiles | `build.copy`  | `[]`           | Copy files from `srcDir` or `projectRoot` to `destionation`. The parser looks for files in the `source` dir first, if no file was fount it looks into the `projectRoot`. You can omit this behavior by adding `$ROOT/` as a prefix to the path. |
|           |               |                |                                                                                                                                                                                                                                                 |

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