1
0
Fork 0

Fix fs docs

This commit is contained in:
Alan Plum 2016-06-27 11:06:30 +02:00
parent 30b7244196
commit dfadefef1d
No known key found for this signature in database
GPG Key ID: 8ED72A9A323B6EFD
2 changed files with 3 additions and 6 deletions

View File

@ -1,6 +1,6 @@
!CHAPTER Filesystem Module
`require('@arangodb/fs')`
`require('fs')`
The implementation tries to follow the CommonJS specification where possible.
[Filesystem/A/0](http://wiki.commonjs.org/wiki/Filesystem/A/0).

View File

@ -8,8 +8,6 @@ The global variables `global`, `process`, `console`, `Buffer`, `__filename` and
ArangoDB supports a number of modules for compatibility with Node.js, including:
util: 4.1.0 (modified)
* [assert](http://nodejs.org/api/assert.html) implements basic assertion and testing functions.
* [buffer](http://nodejs.org/api/buffer.html) implements a binary data type for JavaScript.
@ -20,6 +18,8 @@ util: 4.1.0 (modified)
* [events](http://nodejs.org/api/events.html) implements an event emitter.
* [fs](FileSystem.md) provides a file system API for the manipulation of paths, directories, files, links, and the construction of file streams. ArangoDB implements most [Filesystem/A](http://wiki.commonjs.org/wiki/Filesystem/A) functions.
* [module](http://nodejs.org/api/modules.html) provides direct access to the module system.
* [path](http://nodejs.org/api/path.html) implements functions dealing with filenames and paths.
@ -62,7 +62,6 @@ The following Node.js modules are not available at all:
`dgram`,
`dns`,
`domain`,
`fs` (but see `@arangodb/fs` below),
`http`,
`https`,
`os`,
@ -75,8 +74,6 @@ The following Node.js modules are not available at all:
There are a large number of ArangoDB-specific modules using the `@arangodb` namespace, mostly for internal use by ArangoDB itself. The following however are noteworthy:
* [@arangodb/fs](FileSystem.md) provides a file system API for the manipulation of paths, directories, files, links, and the construction of file streams. ArangoDB implements most [Filesystem/A](http://wiki.commonjs.org/wiki/Filesystem/A) functions.
* [@arangodb/crypto](Crypto.md) provides various cryptography functions including hashing algorithms.
* [@arangodb/foxx](../../Foxx/README.md) is the namespace providing the various building blocks of the Foxx microservice framework.