d2

d2

The full api documentation is available here. To get started we suggest you read the overview. If you already know what you're looking for we suggest the reference material on what is available on the instance of d2.

For more information on how the models work the model module documentation is helpful reference material. For other questions see the FAQ.

Quickstart guide

Install

Start with adding d2 to your project:

yarn add d2 or npm install d2

After installing you will be able to import the library into your project by using the files in the lib folder:

// Using ES2015 imports
import d2 from 'd2';

// Using CommonJS imports
var d2 = require('d2');

Initialise the library

To be able to use d2 you will first need to initialise the library. This is required to let the library know where it should load its data from (e.g. the schemas, currentUser, authorities). The schemas are the definitions of the data model as used in DHIS2.

To do this you can provide d2 with a baseUrl (if you don't provide any the default of ../api will be used):

import { init } from 'd2';

init({ baseUrl: 'http://apps.dhis2.org/dev/api' })
  .then(d2 => {
    //Your d2 is initialised and ready to use.
  });

Get first page of users and print their names

d2.models.user.list()
  .then(userCollection => {
    userCollection.forEach(user => console.log(user.name)));
  });

That's it! See the documentation referenced above for further information.

Report an issue

The issue tracker can be found in DHIS2 JIRA under the LIBS project.

Deep links:

• Bug
• Feature
• Task

Changelog

31.10.2 (2021-11-18)

Bug Fixes

• noop: trigger release due to failed auth (a0626b9)