NodeJS cannot find custom module

Question

I am trying to export a module to my routes file.

My file tree goes like

routes.js
app.js
controllers/users.js
            posts.js

on my app.js I exported var route = require('./routes'); and that works. now on my routes.js I tried to export require('./controllers');.

But it keeps telling me that it cannot find module controllers.

Doing this works:

require('./controllers/users')

But I am trying to follow expressjs sample initial projects format. And it is bugging me because the example of expressjs shows: (express routes is a folder)

var routes = require('./routes');

and loads it like

app.get('/', routes.index);

with no error. and that ./routes is a folder. I am just following the same principle.

nodejs.org/api/modules.html

bryanmac
– bryanmac

2014-02-22 02:51:09 +00:00
Commented Feb 22, 2014 at 2:51 — bryanmac
– bryanmac, Commented Feb 22, 2014 at 2:51

dparpyani · Accepted Answer · 2014-02-22 02:51:18Z

4

If you try to require a directory, it expects there to be an index.js file in that directory. Otherwise, you have to simply require individual files: require('./controllers/users'). Alternatively, you can create an index.js file in the controllers directory and add the following:

module.exports.users = require('./users');
module.exports.posts = require('./posts');

and then import: var c = require('./controllers');. You can then use them via c.users and c.posts.

answered Feb 22, 2014 at 2:51

dparpyani

2,5032 gold badges16 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

2 Comments

majidarif Over a year ago

So how do I call the exports I have on the users.js?

dparpyani Over a year ago

@majimboo Not sure if I understand your question. See here for further details on the module object.

Mukesh Soni · Accepted Answer · 2014-02-22 02:52:34Z

1

You have to understand how require() works.

In your case it fails to find a file named controller.js so it assumes it's a directory and then searches for index.js specifically. That is why it works in the express example.

For your usecase you can do something like this -

var controllerPath = __dirname + '/controllers';
fs.readdirSync(controllerPath).forEach(function(file) {
    require(controllerPath + '/' + file);
});

answered Feb 22, 2014 at 2:52

Mukesh Soni

6,6683 gold badges34 silver badges38 bronze badges

Comments

Community · Accepted Answer · 2020-06-20 09:12:55Z

1

From: http://nodejs.org/api/modules.html

LOAD_AS_DIRECTORY(X)

If X/package.json is a file, a. Parse X/package.json, and look for "main" field. b. let M = X + (json main field) c. LOAD_AS_FILE(M)

If X/index.js is a file, load X/index.js as JavaScript text. STOP

If X/index.node is a file, load X/index.node as binary addon. STOP

So, if a directory has an index.js, it will load that.

Now, look @ expressjs

http://expressjs.com/guide.html

create : myapp/routes

create : myapp/routes/index.js

Taking some time to really read how modules work is time well spent. Read here

edited Jun 20, 2020 at 9:12

CommunityBot

11 silver badge

answered Feb 22, 2014 at 2:57

bryanmac

39.3k10 gold badges93 silver badges99 bronze badges

Collectives™ on Stack Overflow

NodeJS cannot find custom module

3 Answers 3

2 Comments

Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

3 Answers 3

2 Comments

Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related