https://github.com/nodesource/node-native-api
Low-level API for Node
https://github.com/nodesource/node-native-api
Last synced: 10 months ago
JSON representation
Low-level API for Node
- Host: GitHub
- URL: https://github.com/nodesource/node-native-api
- Owner: nodesource
- Created: 2015-03-30T20:23:39.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-04-06T22:18:18.000Z (almost 11 years ago)
- Last Synced: 2025-01-18T13:29:29.508Z (12 months ago)
- Size: 188 KB
- Stars: 13
- Watchers: 17
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## LL-API Interface
The purpose of these documents is to provide a uniform API across Node. It is
meant to be more low-level than the current API, has been tuned for performance
and flexibility. This API has the following goals:
1) Be so light weight that it offers no observable impact on users' code.
2) Be flexible enough that any other desired interface could be written using
it.
3) Be resilient and allow the developer to recover.
### Documents
Most of the documents address API, but there are a couple that explain
generalities.
* `README.md` - You're reading it.
* `design-rules.md` - List of general rules for creating new APIs. It is to
help guide the design process so all APIs can feel as uniform as possible.
* `fs.md` - Some revised API for the file system module.
* `tcp.md` - A TCP API, instead of unified `'net'` module.
* `udp.md` - A UDP API
* `stream.md` - Some streams examples that will be used to write the spec.