mhulse / basic-node-module Goto Github PK

Avoid exporting your class. Use class internally for performance gains, but export a factory that creates instances in order to discourage users from extending your class and avoid forcing callers to use new.

https://medium.com/javascript-scene/why-composition-is-harder-with-classes-c3e627dcd0aa

The above seems to argue that factory functions are preferable over exporting a class from a module.

Throw and try/catch

Use just throw and try/catch around awaits:

basic-node-module/index.js

Lines 51 to 65 in 5df8ced

 if (this.options.orange == 'orange') { 

 // Instead of using `writeFile().then()`, use await: 

 await fs.writeFile(html, 'Hello world!', 'utf8'); 

 let result = await fs.readFile(html, 'utf8'); 

 await fs.unlink(html); 

 // Resolve this async function with the result: 

 return result; 

 } else { 

 throw new Error(`Orange isn’t orange, it’s ${this.options.orange}!`);

Here's example of just throw:

https://github.com/mhulse/get-tile-url/blob/f79b35889e0ad43fda12053cd1d2a1dcd8ef3b61/index.js#L90

Include example of loading scripts from directory

https://stackoverflow.com/a/5365577/922323

mhulse / basic-node-module Goto Github PK

basic-node-module's People

Contributors

Stargazers

Watchers

basic-node-module's Issues

no-return-await

Great info about node.js class instances

Operator precedence for await

Design patterns in Node.js

Class article MUST READ

Throw and try/catch

Include example of loading scripts from directory

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent

	if (this.options.orange == 'orange') {

	// Instead of using `writeFile().then()`, use await:
	await fs.writeFile(html, 'Hello world!', 'utf8');

	let result = await fs.readFile(html, 'utf8');

	await fs.unlink(html);

	// Resolve this async function with the result:
	return result;

	} else {

	throw new Error(`Orange isn’t orange, it’s ${this.options.orange}!`);