Comments (4)
That's how the vast majority of npm modules work, so while we could certainly add it, I'm not sure it's necessary. Have you found many modules where this isn't the case, and they don't document the divergence explicitly?
from node-extend.
I don't know what the standard practice is, as most npm modules I have worked with so far return an object because they expose multiple functions. Although my expectation matched the implementation, I had to check, so being explicit about it is probably a good idea as there are more inexperienced node users out there that you can save some time.
from node-extend.
I'd be open to a PR for it - improving docs readability is always a good thing.
The overwhelmingly standard practice is for modules to have a single default export that's a function, and if extra properties are required, stick them on there. Modules that are grab bags of properties on an object tightly couple the requiring code to the implementation, and are discouraged.
from node-extend.
Thanks, that's good to know.
I'll close this issue and open a pull request in a few minutes.
from node-extend.
Related Issues (20)
- bower and CommonJS / AMD module HOT 1
- no merged when target is not an object or function HOT 5
- ReferenceError: isPlainObject is not defined HOT 5
- why the isArray stuff? HOT 1
- Consider not filtering out properties that are explicitely set to undefined HOT 7
- Difference between extend and Object.assign? HOT 1
- Cannot read config file: node_modules/extend/.eslintrc HOT 6
- update eslint rules HOT 3
- .eslintrc has invalid duplicate setting from npm HOT 3
- Publish most recent changes HOT 2
- Should unify the 'target' arg's protection HOT 1
- Assignment in if statement HOT 1
- Package contains file not is source control HOT 4
- Support for symbols as keys HOT 6
- Changed default branch name to "main" HOT 1
- invalid json syntax in eslintrc file HOT 1
- Security concern HOT 2
- depends on 'extend'. CommonJS or AMD dependencies can cause optimization bailouts. HOT 1
- Provide esm version HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from node-extend.