https://github.com/zephraph/meteor-namespace

A namespacing utility for meteor
https://github.com/zephraph/meteor-namespace

Last synced: about 1 month ago
JSON representation

A namespacing utility for meteor

• Host: GitHub
• URL: https://github.com/zephraph/meteor-namespace
• Owner: zephraph
• License: mit
• Created: 2014-12-28T21:19:31.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2017-06-18T13:12:19.000Z (over 7 years ago)
• Last Synced: 2024-09-29T10:20:57.098Z (about 2 months ago)
• Language: JavaScript
• Size: 8.79 KB
• Stars: 5
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
meteor-namespace

================

A simple javascript namespacing utility that allows the easy creation of **global** namespaces. 

This package functions by creating the namespace and attaching it to ```GLOBAL``` if it's on the server

or ```window``` if it's on the client. Now on NPM!

### Installation

Node

```

npm install meteor-namespace

```

Meteor

```

meteor add zephraph:namespace

```

### Usage

To use this with node add a require like normal:

```js

var Namespace = require('meteor-namespace');

```

Calling the Namespace function creates a global namespace and returns the namespace to be edited

```js

Namespace('my.app.namespace').test = 'hello world';

console.log(my.app.namespace.test); // Prints out 'hello world'

```

When passing in a function 'this' is bound to the specified namespace

```js

Namespace('my.app.namespace', function() {

  this.test2 = 'hello again!';

});

console.log(my.app.namespace.test2); // Prints out 'hello again!'

```

If passing in a object literal the key/value pairs will be added to the namespace

```js

Namespace('my.app.namespace', {

  test3: 'goodbye!'

});

console.log(my.app.namespace.test3); // Prints out 'goodbye!'

```

## Meteor Only

A namespace can be limited to the client or server by calling ```Namespace.server``` or ```Namespace.client```

```js

Namespace.server('my.app.namespace', function() {

  this.serverVal = my.app.do.secret.thing();

});

```