Node.js in Action, Second Edition

Previous Chapter

List of Figures

Index

[SYMBOL][A][B][C][D][E][F][G][H][I][J][K][L][M][N][O][P][Q][R][S][T][U][V][W][X][Y][Z]

SYMBOL

- prefix -- (double hyphen) != prefix ' (backtick) symbol {} (curly brackets) @ symbol && operator = prefix === operator || operator 404 Not Found code 500 status code

A

absolute directory path abstract interface Accept-Encoding header acceptance testing ACID (atomicity, consistency, isolation, durability) ACID guarantees atomicity consistency durability isolation addListener function addPercentageToEach function after function afterEach function Amazon EC2 (Amazon Elastic Compute Cloud) Amazon S3 App class app.configure() method app.get() method app.post route handler app.render() method app.set() method app.use() method, 2^nd append command application data, storing distributed databases, MongoDB embedded databases, LevelDB expense of serialization and deserialization hosted storage in-browser storage localForage API localStorage and sessionStorage APIs reading and writing reading and writing values key/value stores, Redis relational databases ACID guarantees Knex NoSQL PostgreSQL, 2nd selecting database type applications building with webpack bundles and plugins CommonJS configuring and running development server npm packages comparing other platforms to Node database making articles readable and saving them for later making model API dependency deploying from Git repository keeping Node running hosting containers platform as service servers npm scripts RESTful web service server start command starting new structure of user interface multiple format support npm for client-side dependencies templates argument conventions arguments ArrayBuffers arrow functions, 2^nd Article class, 2^nd Article.create method articles articles.sqlite file asar option assert interface assert module adding logic to run tests deepEqual assertion equal assertion example using notDeepEqual assertion notEqual assertion notStrictEqual assertion ok assertion strictEqual assertion testing that thrown errors are correct assert, assertion Async asyncFunction asynchronous programming challenges with one-off events with callbacks parallel flow control, implementing repeating events with event emitters creating event emitters example of extending event emitters responding to events that should occur once sequencing asynchronous logic serial flow control implementing when to use atomicity, consistency, isolation, durability. See ACID. attr() method autoincrement automating deployment automation, using Gulp adding to projects creating and running tasks using separate files for larger projects watching filesystem for changes

B

babel property backtick symbol basic-auth security module basic usage example with curl bcrypt, 2^nd bcrypt.hash() function BDD (behavior-driven development), 2^nd before function beforeEach function bitcount command bitfield command bitop command bitpos command Blobs block expansion, Pug block prepending/appending, Pug blogPage function blpop command body-parser forms JSON data limit option multipart data validating requests bodyParser() method, 2^nd, 3^rd boilerplate break state brew install node command broadcast event browser-based tests brpop command BSON buffer logger option build system

C

cache value callbacks, 2^nd case statements, Pug cb (callback function) CDN (content delivery network), 2^nd, 3^rd, 4^th Chai channel event emitter character escaping, Embedded JavaScript cheerio, scraping with cheerio.load() method Chocolatey package, Redis Chromium, 2^nd .clear() method client value client-side bundle close event close value closures, 2^nd cluster API CMS (content management system), 2^nd, 3^rd collections color variable comma-separated values. See CSV. command-line applications command-line arguments parsing reading files from stdin validating conventions and philosophy of example of interpreting real-world scripts pipes command execution order and errors and exit codes piping data using in Node sharing via npm command-line arguments parsing reading files from stdin validating command-line tools and daemons CommonJS loading modules and assets module specification webpack and CommonJS shims compileDebug value completed counter compression middleware component basic usage custom filter function specifying compression and memory levels compression options Connect middleware, 2^nd body-parser forms JSON data limit option multipart data validating requests combining components compression component basic usage custom filter function specifying compression and memory levels cookie-parser JSON cookies regular cookies setting outgoing cookies signed cookies creating configurable error-handling default error handler handling errors yourself express-session module basic usage manipulating session cookies session stores setting session expiration date working with session data function of method-override module accessing req.method property basic usage morgan module basic usage customizing log formats logger options ordering of qs parse method serve-favicon module serve-index module basic usage using directory() with mounting serve-static module absolute vs. relative directory paths basic usage serving index.html when directory is requested using serve-static with mounting setting up vhost module basic usage using multiple vhost instances web application security basic-auth module csurf module errorhandler module connect.session.Store.prototype const vs. let constructor container content block content delivery network. See CDN. content management system. See CMS. content negotiation, shoutbox app implementing responding with XML Content-Type option context control flow controller, 2^nd cookie-parser JSON cookies regular cookies setting outgoing cookies signed cookies core modules create method createdAt property createdb command CSRF (cross-site request forgery), 2^nd, 3^rd _csrf property --css option CSS preprocessor csurf security module CSV (comma-separated values) cURL curl command curly brackets custom filter function custom routes CWD (current working directory)

D

daemons, 2^nd data events database adapter database model database schema database transaction databases ACID guarantees atomicity consistency durability isolation adding to web applications making articles readable and saving for later making model API Knex connecting and running queries jQuery for databases leaky abstractions swapping database back end MongoDB connecting to identifiers inserting documents installation and setup querying replica sets write concerns NoSQL PostgreSQL connecting to from Node creating database defining tables inserting data MySQL vs. performing installation and setup querying data updating data DEBUG debug value debugger decoupled decr command decrby command deepEqual assertion deepEquals method del command delete keyword DELETE method dependencies property dependency, adding to web applications deploying applications from Git repository keeping Node running DerbyJS RESTful APIs route definition setting up strengths of weaknesses of describe method, 2^nd desktop apps, building with Electron bootstrapping libraries communicating between components defining Request component defining Response component installing dependencies setting up webpack destructuring developer tools directory object __dirname variable, 2^nd distributed databases, MongoDB connecting to identifiers inserting documents installation and setup querying replica sets write concerns div tag, shorthand for in Pug doAsync method, 2^nd Docker, 2^nd document-oriented database dollarFormat function DOM (Document Object Model), 2^nd, 3^rd domain property double hyphen dropdb command Dust dyno, 2^nd

E

echo command ECMAScript, 2^nd ECS (EC2 Container Service) EJS (Embedded JavaScript) integrating in application web application templating with caching templates character escaping client-side applications creating templates integrating into application Elastic Beanstalk Electron builds and distribution electron-packager packaging creating apps creating full desktop apps bootstrapping libraries communicating between components defining Request component defining Response component installing dependencies setting up webpack interface design main process render process stack electron-packager embedded databases, LevelDB API overview installation key/value encodings LevelUP and LevelDOWN packages modular database pluggable back ends reading and writing key/value pairs Embedded JavaScript. See EJS. entries.submit() method entry property environment variables environment-based configuration eq() method equal assertion equality operator err argument err.notFound property error event error handling, Connect middleware default error handler handling errors yourself error streams errorhandler security module basic usage HTML error response JSON error response plain-text error response errorHandler() function event emitters creating events that should occur only once example of extending event handling one-off events with callbacks repeating events with event emitters creating event emitters events that should occur only once example of extending event emitters event listeners event loop, 2^nd EventEmitter class, 2^nd, 3^rd events, defined exists command exit codes exit status expect interface expires property exports object Express application skeleton generating application installing Express executable overview of application planning application configuring content negotiation implementing responding with XML RESTful API adding basic authentication adding entries adding entry listing support designing implementing routing pagination middleware removing sensitive user data testing entries route testing user data retrieval user authentication authenticating user logins creating user model retrieving user data saving and loading user records saving user into Redis securing user passwords testing user-saving logic user login authenticating creating menu for users displaying form user registration adding registration routes creating registration form implementing relaying feedback to users storing transient messages in sessions user-loading middleware user-submitted content adding entry-related routes adding front-page display of entries creating entry form creating entry model flexible validation middleware implementing entry creation performing form validation route-specific middleware validating user content submission view rendering changing lookup directory configuring view system default template engine methods of exposing data to view caching view lookup express-enrouten API express-session module basic usage manipulating session cookies session stores setting session expiration date working with session data express.response object express.static

F

FIFO (first in, first out) file watcher utility, event emitters filename value filesystem (fs) module) filter function Flatiron.js RESTful APIs route definition setting up strengths of weaknesses of Float32Array flow control parallel serial flow control, community tools for foo() function for loops forEach loop form encoding form requests, parsing format property format variable frameworks, server-side comparison of defined DerbyJS RESTful APIs route definition setting up strengths of weaknesses of Flatiron.js RESTful APIs route definition setting up strengths of weaknesses of hapi plugins RESTful APIs route definition setting up strengths of weaknesses of Koa RESTful APIs route definition setting up strengths of weaknesses of Kraken RESTful APIs route definition setting up strengths of weaknesses of LoopBack RESTful APIs route definition setting up strengths of weaknesses of Sails.js RESTful APIs route definition setting up strengths of weaknesses of typical users of, 2^nd agency developer open source developer product developer writing modular code front-end build systems Gulp adding to projects creating and running tasks using separate files for larger projects watching filesystem for changes npm scripts configuring front-end build tools creating custom overview webpack bundles and plugins CommonJS configuring and running development server npm packages fs module fs.createWriteStream fs.watchFile function full-stack framework functional testing, 2^nd

G

generators geospatial indexes get command GET method GET parameters getAllKeys function getrange command getRange function getset command Git repository, deploying applications from global leak detection global lock --global option global scope global variables Gulp adding to projects creating and running tasks using separate files for larger projects watching filesystem for changes gulp-concat plugin gulp-sourcemaps plugin gulp.task() method

H

handleChange method handleRequest function handleSelectTab method hapi plugins RESTful APIs route definition setting up strengths of weaknesses of --harmony flag hashed password hdel command Headers component headless tests --help flag Heroku hexists command hget command HGETALL command hgetall command hidden option hincrby command hincrbyfloat command hkeys command hlen command hmget command hmset command Hogan creating templates fine-tuning Mustache tags displaying simple values inverted sections partials section lambdas sections hosted storage hosting applications containers platform as service servers hot reloading hscan command hset command hsetnx command hstrlen command HTML error response htmlparser module HTTP Authorization header field HTTP messages HTTP verb :http-version token httpOnly property hvals command HyperLogLog hyphen

I

-i option icons option _id property if statements if/else blocks ignoreMethods ImageMagick immediate logger option immediate option in progress features in-browser storage localForage API localStorage and sessionStorage APIs reading and writing reading and writing values include command, Pug included file incr command incrby command incrbyfloat command index.html files, serving when directory is requested --inline option install command installing Node from source with MacOS installer with package manager with Windows Installer interactive debugging interprocess communication IPC (interprocess communication), 2^nd isomorphic, defined it function

J

JavaScript, in Pug templates join callback jQuery jsdom, scraping with jsdom.env method JSON (JavaScript Object Notation), 2^nd, 3^rd, 4^th json spaces option JSON.parse function JSON.stringify() function, 2^nd JSX

K

key/value stores, Redis encoding and data types hashes initialization installation and setup key/value pairs keys lists performance improvement pub/sub with channels sets keyboard shortcuts Knex connecting and running queries jQuery for databases leaky abstractions swapping database back end Koa RESTful APIs route definition setting up strengths of weaknesses of Kraken RESTful APIs route definition setting up strengths of weaknesses of

L

leaky abstraction let vs. const level option LevelDB API overview installation key/value encodings LevelUP and LevelDOWN packages modular database pluggable back ends reading and writing key/value pairs LevelDOWN package LevelUp package lexical scope libraries, bootstrapping libuv LIFO (last in, first out) limit option lindex command linsert command linter listener listeners method llen command loaders localForage API locals.messages variable localStorage API log formats, customizing log rotation logger options LoopBack RESTful APIs route definition setting up strengths of weaknesses of lpop command lpush command lpushx command lrange command lrem command LRU eviction lset command ltrim command LTS (Long-Term Support) Lua scripting

M

MacOS installer, installing Node with maintenance cluster API hosting static files and proxying with Upstart Makara map method maxAge argument, 2^nd MEAN stack (MongoDB, Express, Angular, Node) memdb project memdown memLevel option memoize memory levels, specifying compression and MemoryStore, 2^nd messages variable messages.ejs template method chain method property :method token method-override module accessing req.method property basic usage methodOverride() function mget command microformats, 2^nd middleware MIME (Multipurpose Internet Mail Extensions), 2^nd, 3^rd mixin mixin command, Pug Mocha hooks testing asynchronous logic testing Node applications mocks module.exports mechanism, fine-tuning module creation using module.exports property module.loaders property modules caveats regarding core creation of organizing and reusing functionality reusing MongoDB connecting to identifiers inserting documents installation and setup querying replica sets write concerns mongodb module MongoDB, Express, Angular, Node. See MEAN stack. Monit morgan module basic usage customizing log formats logger options mount point mounting middleware using directory() with using serve-static module with mset command msetnx command .msi installer, Windows multipart data Mustache templating language creating templates tags displaying simple values inverted sections partials section lambdas sections MVC (Model-View-Controller), 2^nd MySQL, PostgreSQL vs.

N

namespaces nargs method native nested callback networking (http) module next argument next() method, 2^nd Nginx, 2^nd node command NODE_DEBUG NODE_ENV variable, 2^nd, 3^rd node_modules folder, reusing modules NODE_PATH variable Node, using pipes in Node.js asynchronous programming challenges with community tools for flow control one-off events with callbacks parallel flow control repeating events with event emitters sequencing asynchronous logic serial flow control built-in tools core modules debugger npm command-line tool ECMAScript 2015 support event loop example of typical web application feature groups installing modules caveats regarding creating fine-tuning creation of reusing nonblocking I/O organizing and reusing functionality release schedule starting new projects types of Node program applications suited to Node command-line tools and daemons desktop applications web applications V8 JavaScript engine nonblocking I/O, 2^nd nonparallel testing NoSQL, 2^nd notDeepEqual assertion notEqual assertion NotFoundError notStrictEqual assertion npm command-line tool for client-side dependencies npm packages with webpack npm scripts configuring front-end build tools creating custom npm install cookie-parser npm run build command npm start command npm test command

O

ObjectIDs Octopart ok assertion once method Open Group open value option tag originalMethod property ORM (object-relational mapping), 2^nd outgoing cookies, setting output property

P

PaaS (platform as service) package manager, installing Node with package.json page() method parallel flow control, implementing parse() method partial .pass property password salt path property percentFormat function performance maintenance cluster API hosting static files and proxying with Upstart pg package pipes command execution order and errors and exit codes piping data using in Node plain-text error response plugins, jQuery POST request, 2^nd, 3^rd PostgreSQL connecting to from Node creating database defining tables inserting data MySQL vs. performing installation and setup querying data updating data postinstall command prefixes PRG (Post/Redirect/Get) pattern primary key process.argv array programming challenges with one-off events with callbacks parallel flow control, implementing repeating events with event emitters creating event emitters example of extending event emitters responding to events that should occur once sequencing asynchronous logic serial flow control implementing when to use Promise object promises property proxying psetex command publicPath option publish-subscribe publish/subscribe logic event emitters Redis Pug block expansion div tag shorthand incorporating data logic case statements conditionally rendering code iterating through objects and arrays JavaScript organizing templates block prepending/appending include command mixin command template inheritance specifying tag attributes specifying tag content

Q

qs parse method, query strings query builder query operators query property query strings

R

rainbow table attacks React React.Component class readability readdirSync method readFile function redirection Redis encoding and data types hashes initialization installation and setup key/value pairs keys lists performance improvement pub/sub with channels saving users into sets redis-server command redis.createClient() function ReferenceError error :referrer token regular cookies regular expressions relational algebra relational databases, 2^nd ACID guarantees atomicity consistency durability isolation Knex connecting and running queries jQuery for databases leaky abstractions swapping database back end NoSQL PostgreSQL connecting to from Node creating database defining tables inserting data MySQL vs. performing installation and setup querying data updating data relative directory path :remote-addr token removeAllListeners method removeMessages() method, 2^nd rename command renamenx command render() method, 2^nd REPL (read-eval-print loop) replica set reply.file method req argument :req token req.accepted array req.body object req.cookies object req.files object req.files.file.path req.method property, accessing req.query property req.remoteUser function req.session object req.session._csrf req.session.cart req.session.messages function req.session.uid function Request component request module request() method require() method, 2^nd, 3^rd res argument :res token res.end() method res.error function res.format() method, 2^nd res.locals.messages function res.locals.user function res.message function res.render() method res.send() method, 2^nd, 3^rd, 4^th res.setHeader() function, 2^nd res.write() method resolve.extensions property Response component response object :response-time token REST (Representational State Transfer) rest parameters restart command RESTful APIs DerbyJS Flatiron.js hapi Koa Kraken LoopBack Sails.js shoutbox app adding basic authentication adding entries adding entry listing support designing implementing routing pagination middleware removing sensitive user data testing entries route testing user data retrieval RESTful web service, building robots.txt route route definition DerbyJS Flatiron.js hapi Koa Kraken LoopBack Sails.js route handler rowCount property rpop command rpush command rpushx command rs.initiate() method

S

S3 (Simple Storage Service) sadd command Sails.js RESTful APIs route definition setting up strengths of weaknesses of salted hash SASS (Syntactically Awesome Style Sheets) files save method --save option .saveSync() method saveUninitialized scan command scard command scope value scope, for cookies scraping defined processing raw data required tools for uses of with cheerio with jsdom script tag, 2^nd, 3^rd, 4^th scripts property, 2^nd sdiff command sdiffstore command section lambda secure property Secure Shell. See SSH. select element SELECT statements Selenium semantic versioning SemVer serial flow control implementing when to use serve-favicon module serve-index module basic usage using directory() with mounting serve-static module absolute versus relative directory paths basic usage serving index.html when directory is requested using with mounting middleware server-side frameworks comparison of defined DerbyJS RESTful APIs route definition setting up strengths of weaknesses of Flatiron.js RESTful APIs route definition setting up strengths of weaknesses of hapi plugins RESTful APIs route definition setting up strengths of weaknesses of Koa RESTful APIs route definition setting up strengths of weaknesses of Kraken RESTful APIs route definition setting up strengths of weaknesses of LoopBack RESTful APIs route definition setting up strengths of weaknesses of Sails.js RESTful APIs route definition setting up strengths of weaknesses of typical users of, 2^nd agency developer open source developer product developer writing modular code server.register method session() function sessionStorage API set command Set-Cookie header, 2^nd setbit command setex command setHeader method setImmediate function setInterval function setMaxListeners method setnx command setrange command setTimeout function, 2^nd shell shipping features should interface Should.js signed cookies significant whitespace Simple Storage Service. See S3. single-page web app single-threaded Sinon.JS spies stubs sinter command sinterstore command sismember command slc command, 2^nd smembers command sort command source map source, installing Node from spop command spread operator SQL (Structured Query Language) SQLite srandmember command srem command sscan command SSH (Secure Shell) stack trace stack, Electron staged features start method state static asset :status token stderr stream, 2^nd stdin, reading files from stdout stream, 2^nd storing application data distributed databases embedded databases expense of serialization and deserialization hosted storage in-browser storage localForage API localStorage and sessionStorage APIs reading and writing reading and writing values key/value stores, Redis relational databases ACID guarantees Knex NoSQL PostgreSQL, 2nd selecting database type stream option, 2^nd strictEqual assertion string property strlen command StrongLoop style tag sudo command, 2^nd sum function sunion command sunionstore command synchronous I/O operations Syntactically Awesome Style Sheets files. See SASS.

T

tar command, 2^nd TDD (test-driven development), 2^nd template engine template language template strings templates, for web applications clean code EJS, integrating in application example of rendering HTML using templates rendering HTML without templates Express default view template engine user interface with Embedded JavaScript caching templates character escaping client-side applications creating templates integrating into application with Hogan and Mustache templating language creating templates fine-tuning Hogan Mustache tags with Pug block expansion div tag shorthand incorporating data logic organizing templates specifying tag attributes specifying tag content test property, 2^nd test runner, 2^nd testing failed tests better stack traces more-detailed logs functional testing unit testing assert module Chai Mocha Should.js Sinon.JS Vows testsCompleted third-party middleware --timeout command title block token function tokens transpilers TTL (time to live) type command type property TypedArrays typeof operator TypeScript

U

Uint8Array unit testing, 2^nd assert module adding logic to run tests deepEqual assertion equal assertion example using notDeepEqual assertion notEqual assertion notStrictEqual assertion ok assertion strictEqual assertion testing that thrown errors are correct Chai Mocha hooks testing asynchronous logic testing Node applications Should.js Sinon.JS spies stubs Vows update method UPDATE query uppercase_trim function Upstart uptime and performance maintenance cluster API hosting static files and proxying with Upstart url property :url token urlencoded body parser use() function user authentication, shoutbox app authenticating user logins creating user model retrieving user data saving and loading user records saving user into Redis securing user passwords testing user-saving logic user interface, adding to web applications multiple format support npm for client-side dependencies templates user login, shoutbox app authenticating creating menu for authenticated and anonymous users displaying form user registration, shoutbox app adding registration routes creating registration form implementing relaying feedback to users storing transient messages in sessions :user-agent token user-submitted content, shoutbox app adding entry-related routes adding front-page display of entries creating entry form creating entry model flexible validation middleware implementing entry creation performing form validation validating submission user:ids value User.authenticate() method, 2^nd, 3^rd User.get() function User.getByName() function User.getId() function user.pass hash utility method

V

V8 JavaScript engine validate.lengthAbove() function validate.required() function validating requests var declarations verify option vertical search engine vhost module basic usage using multiple vhost instances view rendering, shoutbox app changing lookup directory configuring view system default template engine methods of exposing data to view caching view lookup Vows

W

waitForVisible method Wanstrath, Chris watch() method, 2^nd Watcher object web application security basic-auth module basic usage example with curl csurf module errorhandler module basic usage HTML error response JSON error response plain-text error response web application templating clean code example of rendering HTML using templates rendering HTML without templates with Embedded JavaScript caching templates character escaping client-side applications creating templates integrating into application with Hogan and Mustache templating language creating templates fine-tuning Hogan Mustache tags with Pug block expansion div tag shorthand incorporating data logic organizing templates specifying tag attributes specifying tag content web applications, 2^nd building with webpack bundles and plugins CommonJS configuring and running development server npm packages comparing other platforms to Node database making articles readable and saving them for later making model API dependency example of typical npm scripts RESTful web service server start command starting new structure of user interface multiple format support npm for client-side dependencies templates web framework web scraping web worker web-parsing WebdriverIO test webpack bundles and plugins CommonJS configuring and running development server npm packages setting up webpack loader webpack plugin webpackBootstrap shim Windows Installer, installing Node with

X

XML, content negotiation XPath XSS (cross-site scripting) attacks XSS attack

Y

-y flag yargs Yeoman, 2^nd yield keyword

Z

Previous Chapter

List of Figures