sugo-constants/README.md

Constant variables for SUGOS

sugo-constants
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/realglobe-Inc/sugo-constants
[bd_travis_url]: http://travis-ci.org/realglobe-Inc/sugo-constants
[bd_travis_shield_url]: http://img.shields.io/travis/realglobe-Inc/sugo-constants.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/realglobe-Inc/sugo-constants
[bd_travis_com_shield_url]: https://api.travis-ci.com/realglobe-Inc/sugo-constants.svg?token=
[bd_license_url]: https://github.com/realglobe-Inc/sugo-constants/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/realglobe-Inc/sugo-constants
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/realglobe-Inc/sugo-constants.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/realglobe-Inc/sugo-constants.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/realglobe-Inc/sugo-constants
[bd_gemnasium_shield_url]: https://gemnasium.com/realglobe-Inc/sugo-constants.svg
[bd_npm_url]: http://www.npmjs.org/package/sugo-constants
[bd_npm_shield_url]: http://img.shields.io/npm/v/sugo-constants.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Constant variables for SUGOS

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install sugo-constants --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const { HubUrls } = require('sugo-constants')

{
  const { ACTOR_URL, CALLER_URL } = HubUrls
  /* ... */
}

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->

<!-- Section from "doc/guides/03.Values.md.hbs" Start -->

<a name="section-doc-guides-03-values-md"></a>

Values
------

##### ActorEvents

| Key | Value |
| --- | ---- |
| SETUP | `actor:setup` |
| TEARDOWN | `actor:teardown` |
| UPDATE | `actor:update` |
| LOST | `actor:lost` |


##### CallerEvents

| Key | Value |
| --- | ---- |
| JOIN | `caller:join` |
| LEAVE | `caller:leave` |


##### ClientTypes

| Key | Value |
| --- | ---- |
| ACTOR | `sugo:actor` |
| CALLER | `sugo:caller` |
| OBSERVER | `sugo:observer` |


##### HubNotices

| Key | Value |
| --- | ---- |
| CALLER_GONE | `CallerGone` |
| ACTOR_GONE | `ActorGone` |


##### HubUrls

| Key | Value |
| --- | ---- |
| ACTOR_URL | `/actors` |
| CALLER_URL | `/callers` |
| OBSERVER_URL | `/observers` |
| HUB_URL | `/hubs` |


##### PipeLevels

| Key | Value |
| --- | ---- |
| ACTOR_LEVEL | `level:actor` |
| MODULE_LEVEL | `level:module` |


##### ReservedNames

| Key | Value |
| --- | ---- |
| MODULE | `module` |
| METHOD | `constructor,emit,addListener,removeListener,removeAllListeners,listeners,listenerCount,setMaxListeners,getMaxListeners,eventNames,on,off,once,with,of` |
| ATTRIBUTE | `name,prototype,caller` |




<!-- Section from "doc/guides/03.Values.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [Apache-2.0 License](https://github.com/realglobe-Inc/sugo-constants/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [SUGOS][sugos_url]
+ [Realglobe, Inc.][realglobe,_inc__url]

[sugos_url]: https://github.com/realglobe-Inc/sugos
[realglobe,_inc__url]: http://realglobe.jp

<!-- Links End -->