Mainframe config

Shared local configuration for Mainframe packages.

Installation

``sh
yarn add @mainframe/config
`

Usage

The Environment class provides a namespaced persisted configuration and paths to be used.

All other functions need to be provided with an Environment instance they use to interact.

`js
import { Environment, getDaemonSocketPath } from '@mainframe/config'

const env = new Environment('development')
const socketPath = getDaemonSocketPath(env)
`

API

$3

Arguments

1. name: string: name of the environment

$3

#### .name

Returns string the environment name

#### .config

Returns Conf instance

#### .paths

Returns env paths shared by the platform

$3

Arguments

1. env: Environment

Returns string the path to the daemon binary

$3

Arguments

1. env: Environment
1. path: string: the path to the daemon binary

$3

Arguments

1. env: Environment

Returns string the socket path

$3

Arguments

1. env: Environment
1. path: string`: the socket path

License

MIT