20 lines
959 B
JavaScript

describe("'exports' symbol in modules", () => {
const docSet = jsdoc.getDocSetFromFile('test/fixtures/exports.js');
const sayHello = docSet.getByLongname('module:hello/world.sayHello')[0];
const sayGoodbye = docSet.getByLongname('module:hello/world.sayGoodbye')[0];
it('When a symbol starts with the special name "exports" and is in a file with a ' +
'@module tag, the symbol is documented as a member of that module.', () => {
expect(sayHello).toBeObject();
expect(sayHello.kind).toBe('function');
expect(sayHello.memberof).toBe('module:hello/world');
});
it('When a symbol starts with the special name "module.exports" and is in a file with a ' +
'@module tag, the symbol is documented as a member of that module.', () => {
expect(sayGoodbye).toBeObject();
expect(sayGoodbye.kind).toBe('function');
expect(sayGoodbye.memberof).toBe('module:hello/world');
});
});