Grakn Client for Node.js

Client Architecture

To learn about the mechanism that a Grakn Client uses to set up communication with databases running on the Grakn Server, refer to Grakn > Client API > Overview.

API Reference

To learn about the methods available for executing queries and retrieving their answers using Client Node.js, refer to Grakn > Client API > Node.js > API Reference.

Concept API

To learn about the methods available on the concepts retrieved as the answers to Graql queries, refer to Grakn > Concept API > Overview.

Import Grakn Client for Node.js through npm

npm install grakn-client

Further documentation: https://dev.grakn.ai/docs/client-api/nodejs

Build Grakn Client for Node.js from Source

Note: You don't need to compile Grakn Client from source if you just want to use it in your code. See the "Import Grakn Client for Node.js" section above.

1. Make sure you have Node.js (version 14 or above) and its npm package manager installed on your machine
2. Clone the project and run npm install at its root directory (containing package.json)
3. Run npm run build
4. The JavaScript files, and their matching TypeScript type definitions are compiled to the dist directory.

Note: TypeScript is not required in order to run Grakn Client, however its type assertions may make development smoother.