# bridges-console

> REPL for the Bridges application framework

Latest version **1.0.0** (published 2014-12-11) · ISC license · 0 weekly downloads

## Install

```sh
npm install bridges-console
pnpm add bridges-console
yarn add bridges-console
bun add bridges-console
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2014-12-11 |
| First published | 2014-12-11 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 (+5 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | stevenzeiler |

## Links

- npm: https://www.npmjs.com/package/bridges-console
- Repository: https://github.com/stevenzeiler/bridges-console
- Issues: https://github.com/stevenzeiler/bridges-console/issues
- npm.io page: https://npm.io/package/bridges-console

## Dependencies (3)

- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [bluebird](https://npm.io/package/bluebird.md) ^2.3.11
- [require-all-to-camel](https://npm.io/package/require-all-to-camel.md) ^1.0.0

## Recent versions

- 1.0.0 (latest) — 2014-12-11

## README

# Bridges Console

Embedded REPL (Read Eval Print Loop) interactive command line console for Node.js. Users can load classes into the console as global objects for simple interactivity withing a Node.js application. This project is inspired by the incredible usefulness of Rails console, and written for use in Gatewayd (https://gatewayd.org)

## Installation

    npm install --save bridges-console

## Usage

Global objects set in the console's process before instantiation will become available in the interactive console at run time, for example:

    var Console = require('bridges-console');

    global.MyApp = {
      database: {
        connected: false,
        type: 'postgres'
      },
      config: { version: '1.0.1' }
    }

    myAppConsole = new Console;
    myAppConsole.start();

calling `start()` will start the REPL and drop you into the interacive console:

    console> MyApp.config.version; 

which will output the following:

    console> '1.0.1'

#### Options

- loadDirectories: [ArrayOfDirectoryPaths]
    
  Bridges Console includes a tool to load classes from a directory using an opinionated naming scheme that converts the file name from snake case to camel case, then capitalises the first letter, an finally exports the class with its newly computed name to the global namespace.

- prompt: String

  Will set the name of the prompt displayed

#### Exiting

    console> exit

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