docs/js/docs-setup.js
NG_DOCS={
"sections": {
"tutorials": "Tutorials",
"api": "API Documentation",
"demos": "Demos"
},
"pages": [
{
"section": "tutorials",
"id": "index",
"shortName": "index",
"type": "overview",
"moduleName": "index",
"shortDescription": "Documentation",
"keywords": "app assets best cdns clients code demand developing documentation engine events exceptions experiment extending formats gazillion github handling indirectly io low-level message middleware models modules multiple node overview packing practices production protocols reload request responder responders single-page socketstream support template templates tutorials workers wrappers"
},
{
"section": "tutorials",
"id": "authentication",
"shortName": "Authentication",
"type": "overview",
"moduleName": "Authentication",
"shortDescription": "Authentication",
"keywords": "access accesstoken accesstokensecret action actions add adding app append apps authenticate authenticated authenticates authenticating authentication backend best bodyparser browser callback calling change choice client closely code coming command connect connection console consumer consumerkey consumersecret contents control css current data database db define denied details docs don easily enter events everyauth example examples exports express facebook findorcreateuser follow full function geared getcurrentuser github goal host http https integrates internal jade john js ldap libraries libs listen ll load log logout lookup main manually middleware modules multi-page note notifies oauth object option output overview password popular prepend processing production publish real redirectpath register req request require res resource return route router rpc save saves screen_name second secret sending sends serve server service session set setuserid simple socketstream specific ss start started styl supply tempted testing third-party true tutorials twitter twitterusermetadata unique update updating url user userid username users var view visit ways website websocket websockets whilst"
},
{
"section": "tutorials",
"id": "client_side_code",
"shortName": "Client-Side Code",
"type": "overview",
"moduleName": "Client-Side Code",
"shortDescription": "Client-Side Code",
"keywords": "ability absolute absolutely access accessed add additional advised allowing allows alphanumerically amd amount app apply approaches as-is assets automatically aware awesome backbone background bear better blank boiler-plate brought browser browserify browserifyexcludepaths bundle cache call called calls case cases catch change chaos choice clean client client-code client-side code coffee coming command common components connection console copied copy create created critical critically default define demand depend dependencies depends developer developers development difference directores directories directory disable distinction doesn don easily ensure entry entrymodulename error established exact exactly example exceptions exclude excluded excluding execuring execute executed exist expect experience explicitly export facility file files folder forget form functions future generally goal going great handle head history hopes https implications inbuilt info instantly internally isn javascript jquery js killing leading legacy libraries library libs lightweight list live lives ll load loaded loading locks long magic main major making manage managing manually md mess min mind modification modify module modules namespace namespacing node null on-the-fly ondemand onus options order org overview packaging part1 path paths performs point position problem problems production project querystring reconnecting reference regular relative require required requires send serve served server server-side set share sharing side single slash small socketstream solution solutions solves source special ss stack started statement static string structure subdirectories substack syntax system top track treated tricky tutorials type typically underscore unique unstructured url values variable view views wade wanted web websocket window work works write writing"
},
{
"section": "tutorials",
"id": "client_side_constants",
"shortName": "Client-Side Constants",
"type": "overview",
"moduleName": "Client-Side Constants",
"shortDescription": "Client-Side Constants",
"keywords": "aaa accessed add appconfig browser called case client client-side code color common configuration constant constants consts convention copyright css debugging define defined definition defintion environment examples expose facebookappid formatter formatters global good html isn level load loaded local locals myview naming number overview passed rendering send source ss sucks support template_engines tutorials twitterkey values variables version view views write"
},
{
"section": "tutorials",
"id": "client_side_development",
"shortName": "Client-Side Development",
"type": "overview",
"moduleName": "Client-Side Development",
"shortDescription": "Client-Side Development",
"keywords": "additional amount assets base browser bundle bundler bundlers bundles client client-side css determined determines developing development directory entries entry extending file files follow form generally html http identification js loader mod overview parameter passed path pattern production query reduce relative resolved saved separate separately served start string tutorials type url view watch work"
},
{
"section": "tutorials",
"id": "client_side_templates",
"shortName": "Client-Side Templates",
"type": "overview",
"moduleName": "Client-Side Templates",
"shortDescription": "Client-Side Templates",
"keywords": "access accessible alice allowing allows angular apart app append argument astronomy bad bandwidth biology bob browser building built-in bundled called client client-side clients code coffeekup compiled construct convert correct create css data default define destinations directories directory display div don dramatically easy ember engine engines enter example exiting extension external favorite file find flexibility folder format formatter functions generate github good habit happy html including inline iphone jade jquery js languages larger layoutless length lib library libs limit live ll logic main major manually match md mix mixing mobile model model-person module modules mustache notation npm number optional organizing out-of-the-box outputs overview pass passing paths people perfect person practice prefer prefix project raw ready recommended reduces refactoring refresh relative render required requires scale scope second send serve server serving simple simply single-page small socketstream solution source ss ss-hogan string student studies styl style subdirectory suitable supported supports tag template templateengine templates templating time tmpl tmpl- tutorials types var view ways websocket work wrappers wraps"
},
{
"section": "tutorials",
"id": "client_side_xbundler",
"shortName": "Client-Side Bundler",
"type": "overview",
"moduleName": "Client-Side Bundler",
"shortDescription": "Client-Side Bundler",
"keywords": "action additional approach arguments array asset assets aware based behaviour browserify built-in bulk bundle bundler bundlers bundling callback called cb changes client client-side code complete completely config considered contents create css current custom default define definition described destsfor development directly directory dirs discuss dropped early entries existing experimental features file files forced function functionality future html implement implementation implemented implementing individual installtion jade js jspm lacks light load lot method methods minification move named newer next_arg note object objective optimisations options opts overview pack pass passed path paths production referenced relative responsibilities return returns revised saved scss separate served server set shorthand shouldn sourcepaths ss starting starts step supported switch templates text tmpl tutorials types var version view views webpack webpackbundler worker write"
},
{
"section": "tutorials",
"id": "defining_multiple_clients",
"shortName": "Defining Multiple Clients",
"type": "overview",
"moduleName": "Defining Multiple Clients",
"shortDescription": "Defining Multiple Single-Page Clients",
"keywords": "additional allows alphanumerically app application argument asset assets browser browsers calendar called changed choose choosing client client-side clients closely code combination command common config connection consist contents create css default define defined defining demand depending desktop devices directories directory divide duplicate easy example exclusively file files flexibility format framework function headers html http imagine imported individually initial interface iphone iphones jade js layout libraries libs list live lives ll long main match min mix mobile module modules mounted multiple names namespace nature nested note option options order overview pass passing plain power prefer project provide providing recommended require res reset root route sections send sending serve serveclient served serving settings shared sharing short single-page socketstream ss stored structure styl stylesheets stylus sub-directories template templates three tmpl tutorials type typical typically unique url urls user-agent useragent ve view"
},
{
"section": "tutorials",
"id": "faq",
"shortName": "FAQ",
"type": "overview",
"moduleName": "FAQ",
"shortDescription": "Frequently asked questions",
"keywords": "ability active add-on addition allow allows angular api apis app approaches apps areas argument asked assumption auto-restart backbone best big browser browsers changes choice chrome client client-side cloud code commands community compatible complexity config configure connections continue convenience core created currently custom db default deploy details developers developing development documented driver easy ec2 enable excellent experiment fail fallback faq feature featured file firefox flexible framework frequently fully function future google great group heroku high-speed hook host htm htmlfile ideally incoming install installed installs internal io ipads iphones javascript js jsonp-polling keen level libraries localhost log longer major maximize md memory mobile model models module modules mongodb myoptionalpass native net node nodejitsu nodemon nodemonignore npm offer older opinionated optimal optionally order overview pass persistent pick port preserve problems properly protocols publish pubsub questions real redis reduce require routed running sadly safari sake saved scaling seamless search second serialization server server-side servers session sessions set settings share simply simulating socket socketio socketstream sourceforge speed ss start sticky storage store stored sudo support supported synching syncing third-party tools transport transports tutorials use-case users versions ways website websocket websockets well-maintained windows work works ws xhr-polling zeromq"
},
{
"section": "tutorials",
"id": "features",
"shortName": "Features",
"type": "overview",
"moduleName": "Features",
"shortDescription": "Features",
"keywords": "access actions additional ajax app asset assets authenticate authentication automatically backend baked bi-directional browser bundled business call cdn changes changing channels choosing client client-side clients code coffeekup coffeescript communication comprehensive connect css data database default define dependent distributed easily easy effortless enabling engine engines events exports facebook fallbacks faqs fast features file formatters github great hogan hook-in html http ideal includes including installing instantly integrated io jade jquery js libraries list live logging logic maintained manager messy middleware mock model modular modules multiple online optional optionally overview packages private pub publish push reactive reload reloads repl request requests require retrieval router routing rpc scalable seamlessly serve server session sessions share side single-page slow stylus support supported switch template templates terminal transport transports true tutorials twitter update users validation websocket websockets work works wrapper write zepto"
},
{
"section": "tutorials",
"id": "how_it_works",
"shortName": "How it works",
"type": "overview",
"moduleName": "How it works",
"shortDescription": "How does it work?",
"keywords": "action actions ajax alert allows analytics answer app application applications asynchronous automatically basic bi-directional blog box broken browser building call called calling choice client client-side clunky code coming command common communication compressed connection connects console content-rich convention create css data default define depending eagle-eyed engine established example examples exports fallbacks file fine fit follow format function games great hand handlers header html html5 http image included instantly interested invoke invoked invoking javascript js json-over-rpc latency list ll local location logged manner md messages mode modern monitoring multiple naming notice number optimization organize overhead overview perfect platform polling poor popup processed processor production publicly re-established realtime received reload request require requires res resize responders response restart return returned rpc save search send sends server server-side simple site socketstream square squared squares ss static stock streaming sub-directories supports task time trading true tutorials undefined unique urls user var visits ways websocket wondering work works write written"
},
{
"section": "tutorials",
"id": "how_to_write_a_formatter",
"shortName": "How to write a formatter",
"type": "overview",
"moduleName": "How to write a formatter",
"shortDescription": "How to write a formatter ?",
"keywords": "action additional adjust array asset assettype asynchronous based call called calls cb changed charset client code compilation compile compress compressed console constants contenttype created css debugging default describes description don dot encountered error excluding expressions extension extensions feel file forget formatted formatter formatters formatting free function general headers html http implementation info javascript js key locals log logger logging managed mime object option options output overview packed passing pathentry pre-compile provide read render return returning runtime shouldn signature size smallest socketstream source ss string throwing time trace true tutorials type variables warn warning warnings write written"
},
{
"section": "tutorials",
"id": "how_to_write_view_html",
"shortName": "How to write view HTML",
"type": "overview",
"moduleName": "How to write view HTML",
"shortDescription": "How to write view HTML ?",
"keywords": "appending assigntransport behaviour block body browser bundle bundles client closing code configuring connection consider content contents control css default div echo-responder ensure events-responder executed files filled formatter formatters full hand head heavy html huge include insert inserted installation jade javascript js light link loaded loading lot main notation note option overview place plain previous recommended require requirement script scripts seconds send served set size slow socketstream socketstream-rpc ss start startcode startinbundle styled supported synced-model tag tags top true tutorials typical ultimately user view views white write written xhtml"
},
{
"section": "tutorials",
"id": "http_middleware",
"shortName": "HTTP Middleware",
"type": "overview",
"moduleName": "HTTP Middleware",
"shortDescription": "HTTP Middleware",
"keywords": "access accessible add adds allows apart app append appended appending approach asset assets avoid base bottom browser cache changing client clients compress configured connect connect-static connect-winston cookieparser custom customisable days default determining development directly eventmiddleware everyauth exactly example experimental favicon feature file files find flag fs functions future href http https images instance internally js leave limit load loaded loading making manage maxage maxlength maxobjects middleware minimal mode moment number objects options order overview pass passing pick prepend prepended prepending processed readfile repeated req requests require requires running serve serving session sessions set setting settings short single-page size socketstream source ss stack static staticcache store storing strategy support top tutorials variable wanting work"
},
{
"section": "tutorials",
"id": "live_reload",
"shortName": "Live Reloading",
"type": "overview",
"moduleName": "Live Reloading",
"shortDescription": "Live Reloading of Client Files",
"keywords": "add alternatively api app automatically breaks browser built call change client code conf continuous creates css cycle developer development differently directories directory disable doesn don editor emfile enabled error example expected false file files front-end fs higher inotify issue issues js life limit linux live ll log lose max_user_instances mention mode needed node nowritebackup observe open operating options os overview packassets place prevent problems production productivity real refreshing reload reloaded reloading replacing result screen set side soar socketstream ss stylesheets sudo sysctl system temporary text things top-level tutorials tweaking typically vi views vim watch web work works write"
},
{
"section": "tutorials",
"id": "loading_assets_on_demand",
"shortName": "Loading Assets On Demand",
"type": "overview",
"moduleName": "Loading Assets On Demand",
"shortDescription": "Loading Assets On Demand",
"keywords": "additional allowing allows app application assets assume asynchronously automatic better blocking browser built-in caching call callback called client client-side code command contacting create default demand directly directory distinct example execute fancy file folder freeze function future good haven icloud ignore inside instantly js large ll load loaded loading module modules mount multiple namespace nature normal note overview pack requested requests require required retrieved returned root sadly safely sake search sections send server small socketstream ss sub-directories subsequent syntax tutorials var ve writing"
},
{
"section": "tutorials",
"id": "modules",
"shortName": "Modules",
"type": "overview",
"moduleName": "Modules",
"shortDescription": "Loading Modules from app",
"keywords": "allows api app assets build built builtin builtinpath bundlers choose code defaultid dependencies development engines extension-less filename formatters function install internal internally isn js load loaded loading main matched modules overview passed path plugins production project relative require socketstream ss supplied template time tutorials"
},
{
"section": "tutorials",
"id": "production_hosting",
"shortName": "Production Hosting",
"type": "overview",
"moduleName": "Production Hosting",
"shortDescription": "Production Hosting",
"keywords": "activated adding allows alternatively altogether amazon app apps asset assets assigning automatically bear bit built-in cache call catch catching cdn change check checks client cloudfront clustering code coming command concatenated configure configured connection connections console correctly css custom default define defined deleted deploy deploying deployment descriptor descriptors development discover emailserveradmins ensure env environment error errors example exception exceptions exist existing feature file files fine force function future generated generates greatly gzip handle handling high hosting href html http improve include includes insert integrated js large launch libraries limit links linux ll loaded local locally logtodatabase low machine manager maximum media mind minified mode net node note notice number open optimal options org overview pack packassets packed packing pass path performance platform prefix preparing prevent print process processing production ram recommend rel remove repacking requests requires response result return running safety scaling screen served server servers serving set settings setup simulations site socketstream source spend src ss ss_env ss_pack start starts static stylesheet support terminating text things time times timestamp tips traffic tricks true tutorials type typical typically ulimit uncaught uncaughtexception unique updated urls users usual ve viewed websocket work write"
},
{
"section": "tutorials",
"id": "pub_sub_events",
"shortName": "Pub/Sub Events",
"type": "overview",
"moduleName": "Pub/Sub Events",
"shortDescription": "Pub/Sub Events",
"keywords": "achieve actions add addressed alert allow allowing api app argument arguments array assign attached attribute automatically basically behavior benefit better broadcasting browser browsers call calling cases catch cb change channel channelname channels chat chatmessage client clients code command commands config connect connected console created current currently database default designed desired development devices directly disconnected disney driver easily emitter entire erlang errors event events example exist external file files final find fine flash format fred function future goal going ground handler high-throughput horizontal ids implemented implementing in-built includes individual instance internal invoke javascript jerry js json justforme key kids list ll load load-balanced log logged lost maintenance message messages messaging method middleware mind minutes moderate modular msg multiple names node note notice number object offer offline opens outgrows overview pass passed passing persist plan powerful prevent private process processes providing pub publish published publishing push queue queued rare re-connects re-subscribed real receive receiving recommend redis refresh reloads remember req reset retain rooms rpc scalability second send sending sends server server-side servers service session sessionid sessions setuserid share signs simple simply single socketid socketstream special specialoffer specific specifies ss ss-console stored storing subscribe subscribed subscriptions subsequent subset support switch system systems tab tabs time tom transport transports tutorials unaffected unlimited unsubscribe unsubscribes user userid users usual valid websocket works write"
},
{
"section": "tutorials",
"id": "request_middleware",
"shortName": "Request Middleware",
"type": "overview",
"moduleName": "Request Middleware",
"shortDescription": "Request Middleware",
"keywords": "access action actions adding admin allowing allows altogether api app application arg argument arrive attach authorization authorized bear browser call called chain check checkauthenticated code color command concept conflicts connect console contents continuing created creating crud custom custom-defined cyan data database debug debugging define delete denied destination directly don drop easy ensure essentially example exciting executing experimenting exploring exports external familiar file files final finished folder food forward forwards function functions future handles highly http ideas incoming indicates indicating inspect instantly instructs internal internally invoked io js ll load loaded logged message middleware mind models module modules mongodb move multiple multiplier multiplies multiplynumber namespace note npm num number numbers object opportunities optional order output outputs overview param params pass passed perfect permits prevent problems proceeding processed processing provided publish recommend redirect remember repl req request requesting requests res respond retrieve return rpc sanitize scaling second server session sharing showresult simple simply socketstream square ss ss-console start step store strictly system takes terminal test text-utils third-party thought time today topsecret transform tree tutorials typeof typically update user userid var ve wait websocket write"
},
{
"section": "tutorials",
"id": "rpc_responder",
"shortName": "RPC Websocket Responder",
"type": "overview",
"moduleName": "RPC Websocket Responder",
"shortDescription": "RPC Server-side Websocket Responder",
"keywords": "ability access action actions actual add adding alert allows api append args argument arguments array assume best bestsalesperson browser business calculations call callback called callsharedfunction choose client client-side command commands conjunction conn connection console create createconnection data db dell details directions directly doo electronics enddate error example expecting exports file follow function functions hood hp idiom internal intuitively ipad iphone js json latest lcd loads log logic main matched message messages method methods middleware module mongoose multiple mydb mymodule node node_module online overview param2 pass powerful printer procedure product products producttype recommend remember remote render requested require res responder response result return returning returns rpc salesperson scooby selling send sending serializes server server-side share shared sharedfunction sides ss store strictly string tmpl top topselling tree tutorials tv typically unlimited var websocket wire work write"
},
{
"section": "tutorials",
"id": "server_side_testing",
"shortName": "Testing your app",
"type": "overview",
"moduleName": "Testing your app",
"shortDescription": "Testing your app",
"keywords": "actions add allow allows app array assert automatically brand calling calls choice combination commands compared complete considering convert create created describe directly directory equal example experimental exports feature file files framework function future github globally goal going grunt grunt-cli help implementing install instance javascript js json lines ll major memory mkdir mock module node node_modules note npm number output overview package params perfect problems publish recommend releases reporting req request require res responders response return rpc scripts server server-side session sessions socketstream square ss stage start started string subsequent test tested testing tests things time tostring transport tutorials typing unique userid var"
},
{
"section": "tutorials",
"id": "sessions",
"shortName": "Sessions",
"type": "overview",
"moduleName": "Sessions",
"shortDescription": "Sessions",
"keywords": "accessed actions activate add allow api app append argument authentication auto-expiring automatically avoid backend browser bundled call calling cart checkout choice closes configuration connect connect-redis console contents cookie crypto custom data day days default developing easily ensure example excellent expire expiry exports express false file flexibility framework function getsession http in-memory internal js leaks ll load loaded log maxage memory middleware milliseconds myvar note optimum options overview page-based parser passed performing persistent processed production randombytes redis req request requests res retrieved return route router save saved second secret server session sessions set setting shared socketstream speed ss standard start store stores terminated testaction time tostring tutorials updated updatesession user websocket websockets write"
},
{
"section": "tutorials",
"id": "start_targets",
"shortName": "Start Targets",
"type": "overview",
"moduleName": "Start Targets",
"shortDescription": "Start Targets",
"keywords": "api assets build change default depends enabled event events experimental gulp handlers happen hooking http interface listen live live-assets live-reload managed manages middleware my-task named needed note npmjs object orchestrator orchestrator-on-event-cb overview pack-all pack-if-needed packed project react register reload runs serve serve-on-demand server socketstream ss start started starting streaming target targets task tasks things tool tutorials var web"
},
{
"section": "tutorials",
"id": "template_engine_wrappers",
"shortName": "Template Engine Wrappers",
"type": "overview",
"moduleName": "Template Engine Wrappers",
"shortDescription": "Template Engine Wrappers",
"keywords": "add app as-is attach automatically based bearing behavior best browser building bytes call called calls case catch client client-side clientcode closing code command compile compiled compiledtemplate compiling config consider contents create default defaultformatter directly dot easy engine engines example exports extension false file files find folder formatter formatters fs function functions github good guides handles hogan hogan-template ht html idea include init inside jade join js key language large lib library loads map mind module modules needed occasionally opening overview overwrite party pass passing path performance pick points pre-compile pre-processing preferred prefix process prove readfilesync ready reference relative render require return returns selectformatter selecting selects send sending server side simply socketstream ss suffix supports tag template templates templating text third time tips tmpl trade transform transforming true tutorials twitter type uncommon utf8 var variety vm wide wire wrap wrapper wrappers written"
},
{
"section": "tutorials",
"id": "url_scheme",
"shortName": "URL Scheme",
"type": "overview",
"moduleName": "URL Scheme",
"shortDescription": "URL Scheme",
"keywords": "ad assets calling change choose client code common completely consider considered contents css current demand development directory equivalent exported fetching files fly form future handled hoc html ideally js level loading middleware minified module modules on-demand open overview packed partially path paths production relative root saved scheme sense serve serveclient served serving static support time tutorials url urls view views whitelist work"
},
{
"section": "tutorials",
"id": "using_emberjs",
"shortName": "Use Ember JS",
"type": "overview",
"moduleName": "Use Ember JS",
"shortDescription": "Use Ember JS",
"keywords": "add allaredone app application appreciated array arraycontroller backend bound browser capabilities checkbox clearcompletedtodos client code collection configuration content contentbinding contributed controller copy core create created creates createtodo createtodoview crossroads css data declared define defined defining described directly directory display doc dom downloaded early easy editing elements em ember enable end-point engine ensure event everyproperty example extend file filterproperty finally foreach framework function google group handlebar handler handlers head hold holds html http improve info insertnewline integrate isdone item itemclassbinding items jquery js kindly length lib libraries libs limit list load loaded loading min model mvc new-todo newly note order overview parsed path placeholder point properly property pull ready removeobject rendered requests require res retrieve return route router routing rpc scripts seamlessly second serveclient seteach simple socketstream ss steps support tagname tags template templateengine templates textfield title titlebinding tmpl todo todos todoscontroller true tutorials ul undefined usual valuebinding variables view views website window wiring works"
},
{
"section": "tutorials",
"id": "web_workers",
"shortName": "Web Workers",
"type": "overview",
"moduleName": "Web Workers",
"shortDescription": "Web Workers",
"keywords": "addeventlistener automatic basic blocking browser browsers caching calculate calculatepi calculating calculations call client client-side code coffee coffeescript compilation complex console create cycles data default don easy example execute experiment false file folder formula function general great html5rocks http installed invoke javascript js live ll load log main message messages minification modern module numbers org output overview packassets passing pi postmessage print provide providing read result return running seconds separate socketstream ss ss-coffee start started task tasks thread transparent tutorial tutorials var web wikipedia work worker workers written"
},
{
"section": "tutorials",
"id": "writing_request_responders",
"shortName": "Custom Request Responder",
"type": "overview",
"moduleName": "Custom Request Responder",
"shortDescription": "Custom Request Responder",
"keywords": "access action add adding additional aimed allow allowing allows annotated api apitree app appending application applications arbitrary argument arguments assigned assuming async automatically backbone basic basically best bi-directional browser build built-in bundled byte bytes calculate call callback callbacks called case channel character choice choose clicks client client-side clone code combination comfortable commas complete complex concepts config connection conscious continually control coordinate core create creating custom data default define defined desire destined develop developer developers digits directions directly documentation easier easily echo efficient ember encountered entirely errors event events exactly example experiment experimental explore extend external feature fewer files find flexibility flowing format freenode function functionally future gaming git github going groups handler handles heartbeat help hesitate high-speed http https ideas implement implementing incoming increase info inspiration interfaces internal introduction investigate invoked io irc issue javascript js json json-serialized left length libraries ll load loaded log lot low-bandwidth main message messages method middleware mode model models module modules mongodb-esq mouse movements moving namespacing node non-blocking note notice npm number numeric object objects online optional org outgoing overhead overview packet-sniff packing param1 param2 pass passed passing persistent pick pipe prepended presence process production protocol pub publish receives recommend register registerapi registering regular repl request requests responder responderid responders result rpc rpc-style runs schema second send sending sends separated sequential serialization serialize server server-side simple simply socket socketstream source ss ss-console ss-echo-responder stable stack stage started status store streaming streams string strings suite support synching takes test third-party time touch transforms transports tutorials types typical ultimate ultra ultra-simple unique unlimited user users ve versa vice view virtual ways website websocket wire world write writing zeromq"
},
{
"section": "api",
"id": "bundler",
"shortName": "bundler",
"type": "service",
"moduleName": "bundler",
"shortDescription": "Bundlers included.",
"keywords": "api bundler bundlers included service"
},
{
"section": "api",
"id": "bundler.default:default",
"shortName": "default",
"type": "service",
"moduleName": "bundler",
"shortDescription": "The default bundler of HTML, CSS & JS",
"keywords": "add allow api arguments array asset assetcss assethtml assetjs assetloader assets assetstart assettype assetworker attempt browser build bundle bundler called case cleancss client client-side code collection config content css default define depending describes dir directory entries entry extension file files function functions html htmltags implementation importedfrom includes initcode javascript js leading lib library libs list load loader local method minified minify module modules multiple names output pack path pre-loaded production pulled relative require resolveassetlink resource return script server service slash source special start started stopped strings system systemassets systemmodule tag tmpl tominifiedcss tominifiedjs type uglify unload vars view worker wrapcode wrapped wrapper"
},
{
"section": "api",
"id": "client",
"shortName": "client",
"type": "service",
"moduleName": "client",
"shortDescription": "Client serving, bundling, development, building.",
"keywords": "api building bundling client clients css defined development file html js module production require returned served service serving single socketstream"
},
{
"section": "api",
"id": "client.define",
"shortName": "client.define",
"type": "service",
"moduleName": "client",
"shortDescription": "Define a client view to serve.",
"keywords": "api client clientdefinition code css define definition function http logical my-view paths res route serve serveclient service ss tmpl view"
},
{
"section": "api",
"id": "client.formatters:formatters",
"shortName": "formatters",
"type": "service",
"moduleName": "client",
"shortDescription": "This is for the module returned by require('socketstream').client.formatters.",
"keywords": "add api asset client config configuring define formatter formatters method module nameormodule object parameters rendering require returned service socketstream"
},
{
"section": "api",
"id": "client.formatters:formatters",
"shortName": "formatters",
"type": "service",
"moduleName": "client",
"shortDescription": "Formatter registry",
"keywords": "api client formatter formatters registry service"
},
{
"section": "api",
"id": "client.task",
"shortName": "client.task",
"type": "service",
"moduleName": "client",
"keywords": "api array client dependents execute execution fn service task tasks"
},
{
"section": "api",
"id": "client.templateEngine:templateEngine",
"shortName": "templateEngine",
"type": "service",
"moduleName": "client",
"shortDescription": "This is for the module returned by require('socketstream').client.templateEngine.",
"keywords": "angular api built-in bundler callback cb client config custom custom-engine default directories dirs ember engine engines enging entries error files function generate indicated instance making markup module object output passed receive render require returned service socketstream ss string template templateengine templates templating"
},
{
"section": "api",
"id": "events",
"shortName": "events",
"type": "service",
"moduleName": "events",
"shortDescription": "Internal Event bus.",
"keywords": "api assets bus emitted event events expended idea internal module note production saved server service socketstream ss-console starts"
},
{
"section": "api",
"id": "http.index:index",
"shortName": "index",
"type": "service",
"moduleName": "http",
"shortDescription": "HTTP Server",
"keywords": "api app application assets attached callback concern connect css expose fn function http instance js load merge middleware newsettings object optional options path res route routing serveclient server servers service serving session sessionoptions sessionstore set settings settins short-form simply socketstream stack static staticcache staticpath store string updated url var web wishes"
},
{
"section": "api",
"id": "http.router:router",
"shortName": "router",
"type": "service",
"moduleName": "http",
"shortDescription": "Right now the router is simply an EventEmitter. This may change in the future",
"keywords": "allows api callback cb change clients ee eventemitter exists fall find fully function future html5 http instance mock multiple object original passed pushstate recursively req request res respond route router routing service simply single-page speed support url"
},
{
"section": "api",
"id": "ss",
"shortName": "ss",
"type": "overview",
"moduleName": "ss",
"shortDescription": "Internal API object which is passed to sub-modules and can be used within your app.",
"keywords": "access add api app caution env exports function internal log object overview passed require root session socketstream ss string sub-modules var"
},
{
"section": "api",
"id": "ss.add",
"shortName": "ss.add",
"type": "function",
"moduleName": "ss",
"shortDescription": "Call from your app to safely extend the 'ss' internal API object passed through to your /server code",
"keywords": "add api app call code extend fn function internal key object passed safely ss"
},
{
"section": "api",
"id": "ss.bundler:bundler",
"shortName": "bundler",
"type": "service",
"moduleName": "ss",
"shortDescription": "Client bundling API",
"keywords": "actual api args arguments assets bundler bundlers bundling call client containerdir content custom default define definition describe describing descriptor destinations destsfor determine dir directly entry entry-points file implementing libraries locations method module object offer params passed paths query relpaths replace require return service single ss store system systemlibs systemmodule true tweak wrap wrapped"
},
{
"section": "api",
"id": "ss.client:client",
"shortName": "client",
"type": "service",
"moduleName": "ss",
"shortDescription": "Allow other libs to send assets to the client",
"keywords": "add allow allows api assets client code coffee compress content flags format function js lib library libs module options require send service ss system type"
},
{
"section": "api",
"id": "ss.env",
"shortName": "ss.env",
"type": "property",
"moduleName": "ss",
"keywords": "api change default development env environment execution node_env property set ss ss_env type variable"
},
{
"section": "api",
"id": "ss.log:log",
"shortName": "log",
"type": "service",
"moduleName": "ss",
"shortDescription": "Contains method stubs for logging to console (by default) or",
"keywords": "api apply arguments assigning calls choose console debug default error fairly function happened info informed keeping level log logging method override parameters plugins provider require service socketstream ss stubs switch sysadmin takes time trace tracing trivial unexpected var wakeup warn winston"
},
{
"section": "api",
"id": "ss.publish:publish",
"shortName": "publish",
"type": "service",
"moduleName": "ss",
"shortDescription": "Extend the internal API with a publish object you can call from your own server-side code",
"keywords": "active api browsers call channel client code ended event extend function internal object parameter publish server-side service ss"
},
{
"section": "api",
"id": "ss.root",
"shortName": "ss.root",
"type": "property",
"moduleName": "ss",
"shortDescription": "By default the project root is the current working directory",
"keywords": "api current default directory project property root ss working"
},
{
"section": "api",
"id": "ss.server:server",
"shortName": "server",
"type": "service",
"moduleName": "ss",
"shortDescription": "Server parts used while running",
"keywords": "api parts running server service ss"
},
{
"section": "api",
"id": "ss.version",
"shortName": "ss.version",
"type": "property",
"moduleName": "ss",
"keywords": "api major minor property ss version"
},
{
"section": "api",
"id": "start",
"shortName": "start",
"type": "function",
"moduleName": "start",
"shortDescription": "Starts the development or production server",
"keywords": "api development function http instance module production server start starts"
},
{
"section": "api",
"id": "utils",
"shortName": "utils",
"type": "service",
"moduleName": "utils",
"shortDescription": "Contains utils modules for working with file system and some additional helpers",
"keywords": "additional api file helpers modules service system utils working"
},
{
"section": "api",
"id": "utils.file:file",
"shortName": "file",
"type": "service",
"moduleName": "utils",
"shortDescription": "This is used to maintain lists of userIds to socketIds and channelIds to socketIds",
"keywords": "absolute adapted api array basename basepath channelids contents css dir directory dorectory eror extension file filepath files find findextforbase findextforbasepath github givven https isdir jade json lists loadpackagejson loads lookup maintain matching mode null object package parse path readdirsync reads returns root service socketids socketstream start synchronous thorws true unable userids utils views"
},
{
"section": "api",
"id": "utils.misc:misc",
"shortName": "misc",
"type": "service",
"moduleName": "utils",
"shortDescription": "Module contains misc methods",
"keywords": "adapted api args arguments array body broofa contents declaring default defaults expected extend extended http incoming js len length message messages methods misc module msg obj object parameter parse parsewsmessage randomstring service string type underscore utils uuid websocket"
},
{
"section": "api",
"id": "utils.unique_set:UniqueSet",
"shortName": "UniqueSet",
"type": "service",
"moduleName": "utils",
"shortDescription": "This is used to maintain lists of userIds to socketIds and channelIds to socketIds",
"keywords": "accotding add api array assigned channelids key link lists maintain members names removal remove removefromall returns service set sets socketids specific status unique_set uniqueset userids utils values"
},
{
"section": "demos",
"id": "index",
"shortName": "index",
"type": "overview",
"moduleName": "index",
"shortDescription": "Demos",
"keywords": "css dashboards demo demos html http javascript official org overview project realtime socketstream widgets"
}
],
"apis": {
"tutorials": false,
"api": true,
"demos": false
},
"html5Mode": false,
"editExample": true,
"startPage": "tutorials",
"discussions": {
"shortName": "socketstream",
"url": "http://romanminkin.github.io/socketstream/docs/",
"dev": true
},
"scripts": [
"angular.min.js"
]
};