https://github.com/titarenko/ong

Oh no! Globals!
https://github.com/titarenko/ong

Last synced: about 1 month ago
JSON representation

Oh no! Globals!

• Host: GitHub
• URL: https://github.com/titarenko/ong
• Owner: titarenko
• Created: 2015-08-07T09:09:27.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-08-07T11:30:32.000Z (over 9 years ago)
• Last Synced: 2024-08-09T20:12:28.845Z (5 months ago)
• Language: JavaScript
• Size: 113 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ong

Oh no! Globals!

[![Build Status](https://secure.travis-ci.org/titarenko/ong.png?branch=master)](https://travis-ci.org/titarenko/ong) [![Coverage Status](https://coveralls.io/repos/titarenko/ong/badge.png)](https://coveralls.io/r/titarenko/ong)

[![NPM](https://nodei.co/npm/ong.png?downloads=true&stars=true)](https://nodei.co/npm/ong/)

# Installation

```bash

npm i ong --save

```

# Example

```js

require('ong').init().register({

	db: require('mydb')({ host: 'thishost '}),

	queue: require('myqueue')({ host: 'thathost' })

});

Promise.all([

	$.db.query('select * from everything'),

	$.queue.publish('universe', _.camelCase('my message'))

]).return(0).then(process.exit);

```

As you see from this example, Promise (bluebird), _ (lodash), and $ (registered shortcuts) are globals registered by ong and can be used anywhere within a process.

# API

## init([overwrite])

Registers 3 global variables (yes, global, because they are *very* intensively used): `Promise` (bluebird), `_` (lodash), `$` (shortcuts object). Warning! It will throw error if such globals already exist!

## register(name, value, [overwrite]) or registerGlobal(nameValueObject, [overwrite])

Puts `name` property to global `$` with `value`. Also can be called with 1 argument of type object, each property-value pair of it will be treated as `name`-`value` pair. There is also additional last argument which specifies whether previous value can be overwritten if exists (by default `ong` will throw if such name is already registered).

# License

MIT