The following global variables are available throughout ArangoDB and Foxx:
ArangoDB supports a number of modules for compatibility with Node.js, including:
implements basic assertion and testing functions.
implements an event emitter.
fsprovides a file system API for the manipulation of paths, directories, files,links, and the construction of file streams. ArangoDB implements mostfunctions.
moduleprovides direct access to the module system.
implements functions dealing with filenames and paths.
punycodeimplements conversion functions for encoding.
querystringprovides utilities for dealing with query strings.
provides a streaming interface.
string_decoderimplements logic for decoding buffers into strings.
provides utilities for URL resolution and parsing.
utilprovides general utility functions like
Additionally ArangoDB provides partial implementations for the following modules:
cwd;stubs for ,
The following Node.js modules are not available at all:
There are a large number of ArangoDB-specific modules using the
@arangodbnamespace, mostly for internal use by ArangoDB itself. The following modulesnoteworthy however and intended to be used by the user:
provides direct access to the database and its collections.
@arangodb/analyzersprovides an interface to manage ArangoSearch Analyzers.
AQL related modules:
provides various cryptography functions including hashing algorithms.
Graph related modules:
is used for setting up and synchronizing data for Master/Slave replication.
@arangodb/tasksimplements task management methods
provides an interface for user management.
The following NPM modulesare preinstalled:
is a simple utility function for formatting multi-line strings.
error-stack-parserparses stacktraces into a more useful format.
is an ArangoDB-compatible GraphQL server/schema implementation.
highlight.jsis an HTML syntax highlighter.
is a utility library for inflecting (e.g. pluralizing) words.
iconv-liteis a utility library for converting between character encodings
is a validation library that is supported throughout the Foxx framework.
minimatchis a glob matcher for matching wildcards in file paths.
provides utilities for dealing with query strings using a different formatthan the querystring module.
semveris a utility library for handling semver version numbers.
is a mocking library for writing test stubs, mocks and spies.