module.exports מול exports ב-Node.js, עם דוגמאות

module.exports הוא הערך שקובץ Node.js נותן לכל קובץ אחר שטוען אותו עם require(). הוא מתחיל כאובייקט ריק: מוסיפים לו מאפיינים כדי לייצא כמה דברים, או מציבים לו ערך חדש (פונקציה, מחלקה) כדי לייצא דבר אחד. exports הוא משתנה מקוצר שמצביע על אותו אובייקט, לכן exports.add = ... עובד, אבל exports = ... שובר את הקישור ולא מייצא כלום.

const fs = require('fs');

// setup: write a second module next to index.js
fs.writeFileSync('math.js', `
module.exports.add = (a, b) => a + b;
exports.multiply = (a, b) => a * b;
module.exports.PI = 3.14159;
`);

const math = require('./math');

console.log(math.add(2, 3), math.multiply(4, 5), math.PI);
console.log(Object.keys(math));

הוא הדפיס 5 20 3.14159, ואז [ 'add', 'multiply', 'PI' ]. כל שלוש השורות ב-math.js הוסיפו מאפיינים לאותו אובייקט, בין אם דרך module.exports ובין אם דרך exports, ו-require('./math') החזיר את האובייקט הזה.

ייצוא של פונקציה, מחלקה או אובייקט

כשלמודול יש דבר מרכזי אחד, הציבו אותו ישירות ב-module.exports. מי שקורא למודול מקבל את הפונקציה עצמה, ולא אובייקט שעוטף אותה:

const fs = require('fs');

// setup: two modules, one exports a function, one a class
fs.writeFileSync('greet.js', `
module.exports = function greet(name) {
    return 'Hello, ' + name;
};
`);
fs.writeFileSync('user.js', `
class User {
    constructor(name) { this.name = name; }
    describe() { return this.name + ' (user)'; }
}
module.exports = User;
`);

const greet = require('./greet');
const User = require('./user');

console.log(greet('Ada'));
console.log(new User('Grace').describe());

הוא הדפיס Hello, Ada ו-Grace (user). אם אתם רואים TypeError: greet is not a function, הקוד הקורא השתמש בצורה הלא נכונה: כתבו const { greet } = require(...) עבור מאפיין של אובייקט, ו-const greet = require(...) עבור ערך שהוצב.

module.exports מול exports: מלכודת ההצבה

לפני שהקובץ שלכם רץ, Node.js מגדיר exports = module.exports. שני השמות מצביעים על אותו אובייקט, ו-require מחזיר את module.exports. הצבת ערך חדש ל-exports משנה רק את המשתנה המקומי:

const fs = require('fs');

// setup: the same export written two ways
fs.writeFileSync('broken.js', 'exports = { version: 2 };');
fs.writeFileSync('working.js', 'module.exports = { version: 2 };');

console.log('broken:', require('./broken'));
console.log('working:', require('./working'));

broken.js ייצא {}, כי exports מצביע עכשיו על אובייקט חדש ששום דבר לא מחזיר. working.js ייצא { version: 2 }.

הכלל הפשוט ביותר: תמיד כתבו module.exports. זה עובד בכל מקרה, והקוד אומר מה הוא עושה.

require מחזיר את אותו אובייקט מה-cache

Node.js מריץ את הקוד של מודול פעם אחת, בפעם הראשונה שעושים לו require, ושומר את module.exports ב-cache. כל require מאוחר יותר של אותו קובץ מחזיר את אותו אובייקט, כך שמצב שנמצא בתוך מודול משותף לכל קובץ שטוען אותו:

const fs = require('fs');

// setup: a module that counts and logs when it loads
fs.writeFileSync('counter.js', `
console.log('counter.js is running');
let count = 0;
module.exports = { next: () => ++count };
`);

const a = require('./counter');
const b = require('./counter.js');

a.next();
a.next();
console.log('b sees', b.next());
console.log('same object:', a === b);

counter.js is running הופיע פעם אחת, b.next() החזיר 3, ו-a === b הוא true, כי המפתח ב-cache הוא הנתיב המלא של הקובץ, ו-./counter ו-./counter.js מצביעים על אותו קובץ. בגלל זה חיבור למסד נתונים או אובייקט הגדרות שנוצרו במודול אחד משותפים לכל האפליקציה.

module.exports ו-ES modules

ב-ES modules משתמשים ב-export וב-import. הצורות מקבילות זו לזו כך:

// CommonJS                              // ES modules
module.exports = greet;                  export default greet;
module.exports.add = add;                export { add };
const greet = require('./greet');        import greet from './greet.js';
const { add } = require('./math');       import { add } from './math.js';

ES module יכול לעשות import לקובץ CommonJS: ה-module.exports שלו מגיע כ-default import. מאז Node.js 22.12, גם require() יכול לטעון ES module שאין בו await ברמה העליונה. מתי לבחור במה, ראו CommonJS מול ES modules.

טעויות נפוצות

ערבוב של exports.x עם module.exports = ... באותו קובץ. ההצבה מחליפה את האובייקט, וכל exports.x שנכתב לפניה נעלם. בחרו סגנון אחד לכל קובץ.

ייצוא של ערך שמשתנה בהמשך. module.exports = { count } מעתיק את המספר ברגע הטעינה; כשהמודול מעדכן את count, הקוראים עדיין רואים את הערך הישן. ייצאו פונקציה שמחזירה אותו, כמו ש-counter.js עושה למעלה.

השמטה של ./. require('math') מחפש חבילה ב-node_modules, לא את math.js שנמצא ליד הקובץ שלכם. קבצים מקומיים תמיד מתחילים ב-./ או ב-../.