Jim Lynch Codes
  • Blog
  • About Jim

Writings about one coder's stories & experiences.

index.js- The "Document Class" of NodeJS

1/25/2016

0 Comments

 
Back in the Flash days (I'm not that old, really) we would call the first class that is run when your application starts up the document class. In was common to call this class Main.as or just the name of your project with dot as after it. The language didn't force you to use any specific file name, but it didn't give any special treatment to any name in particular either. Well, in Node.js the creators have blessed us with some special features of a Javascript file named index.js. The name and function is similar to html's index.html as the main html file for a page.
Let's recall how to run a file with node. You can either cd down to the folder where the file resides or just explicitly state the file path (note, this is bash that I'm using in the mac terminal program):
bobolicious3000$ node ~/Little-Node-Projects/basic-require-object/index.js
Note that you could also omit the ".js" extension in the name and node will know to look for a Javascript file with that name:
bobolicious3000$ node ~/Little-Node-Projects/basic-require-object/index
Now here's the magic. If you just specify the name of a directory with no file name then node will automatically look for a file named index.js inside the specified folder:
bobolicious3000$ node ~/Little-Node-Projects/basic-require-object

The cool thing is that all of these commands will run the exact same file in the exact same way. Here's a super simple one-liner sample index.js file for you to try it out yourself!
​index.js
console.log("The file ran!")
0 Comments

Your comment will be posted after it is approved.


Leave a Reply.

    ​Author

    Picture
    The posts on this site are written and maintained by Jim Lynch. About Jim...
    Picture
    Follow @JimLynchCodes
    Follow @JimLynchCodes

    Categories

    All
    Actionscript 3
    Angular
    AngularJS
    Automated Testing
    AWS Lambda
    Behavior Driven Development
    Blockchain
    Blogging
    Business Building
    C#
    C / C++
    ClojureScript / Clojure
    Coding
    Community Service
    CS Philosophy
    Css / Scss
    Dev Ops
    Firebase
    Fitness
    Flash
    Front End
    Functional Programming
    Git
    Go Lang
    Haskell
    Illustrations
    Investing
    Java
    Javascript
    Lean
    Life
    Linux
    Logic Pro
    Music
    Node.js
    Planning
    Productivity
    Professionalism
    Python
    React
    Redux / Ngrx
    Refactoring
    Reusable Components
    Rust
    Security
    Serverless
    Shell Scripting
    Swift
    Test Driven Development
    Things
    TypeScript
    Useful Sites
    Useful Tools
    Video
    Website Development
    WebStorm
    Writing

    Archives

    March 2023
    August 2021
    February 2021
    January 2021
    October 2020
    September 2020
    May 2020
    April 2020
    February 2020
    January 2020
    December 2019
    October 2019
    September 2019
    August 2019
    July 2019
    June 2019
    May 2019
    April 2019
    March 2019
    February 2019
    January 2019
    December 2018
    November 2018
    October 2018
    September 2018
    August 2018
    June 2018
    May 2018
    April 2018
    March 2018
    February 2018
    January 2018
    December 2017
    November 2017
    October 2017
    September 2017
    August 2017
    July 2017
    May 2017
    April 2017
    March 2017
    February 2017
    January 2017
    December 2016
    November 2016
    October 2016
    September 2016
    August 2016
    July 2016
    June 2016
    May 2016
    April 2016
    March 2016
    February 2016
    January 2016
    December 2015
    November 2015
    October 2015

    RSS Feed

  • Blog
  • About Jim
JimLynchCodes © 2023