Skip to content
TypeScript JavaScript Other
Branch: v1
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
guides
samples
scripts
src
type_templates
.cognite-git.json Initial commit Dec 18, 2018
.editorconfig
.gitignore
.prettierrc
.travis.yml
CHANGELOG.md chore(release): 2.11.0 [skip ci] Nov 9, 2019
CODE_OF_CONDUCT.md
LICENSE Initial commit Dec 18, 2018
README.md docs(readme): fix links to renamed repo (#306) Oct 30, 2019
codecov.yml
cognite_logo.png Initial commit Dec 18, 2018
commitlint.config.js
firebase.json
jest.config.js
package.json
rollup.config.js chore: Fix file path for generated TS types file May 20, 2019
tsconfig.json feat: Track request with headers May 20, 2019
tslint.json
typedoc.js feat: asset & assetList class Aug 5, 2019
yarn.lock refactor: complete codebase cleanup Sep 5, 2019

README.md

Cognite logo

Cognite Javascript SDK

Build Status codecov

The Cognite js library provides convenient access to the Cognite API from applications written in client- or server-side JavaScript.

The SDK supports authentication through api-keys (for server-side applications) and bearer tokens (for web applications).

Installation

Video quickstart
Cognite JS SDK video guide

Install the package with yarn:

$ yarn add @cognite/sdk

or npm

$ npm install @cognite/sdk --save

Usage

const { CogniteClient } = require('@cognite/sdk');

Using ES modules

import { CogniteClient } from '@cognite/sdk';

Using typescript

The SDK is written in native typescript, so no extra types needs to be defined.

Quickstart

Web

import { CogniteClient } from '@cognite/sdk';

async function quickstart() {
  const client = new CogniteClient({ appId: 'YOUR APPLICATION NAME' });
  client.loginWithOAuth({
    project: 'publicdata',
  });

  const assets = await client.assets
    .list()
    .autoPagingToArray({ limit: 100 });
}
quickstart();

For more details about SDK authentication see this document.
Also, more comprehensive intro guide with a demo app can be found here

Backend

const { CogniteClient } = require('@cognite/sdk');

async function quickstart() {
  const client = new CogniteClient({ appId: 'YOUR APPLICATION NAME' });
  client.loginWithApiKey({
    project: 'publicdata',
    apiKey: 'YOUR_SECRET_API_KEY',
  });

  const assets = await client.assets
    .list()
    .autoPagingToArray({ limit: 100 });
}
quickstart();

Samples

Samples are in the samples/ directory. The samples' README.md has instructions for running the samples.

Documentation

Migration

See this guide on how to migrate from version 1.x.x to version 2.x.x.

License

Apache 2.0

Development

There is one integration test that requires a api key. In order to run this, you need an api key for the cognitesdk-js tenant. Talk to any of the contributors or leave an issue and it'll get sorted. Travis will run the test and has its own api key. Set the environment variable COGNITE_CREDENTIALS to your api-key.

Run all tests:

$ yarn
$ yarn test

Set the environment variable REVISION_3D_INTEGRATION_TEST=true to run 3D revision integration tests.

We use jest to run tests, see their documentation for more information.

Versioning

The library follow Semantic Versioning.

Contributing

Contributions welcome! See the code of conduct.

Release

Our releases are fully automated. Only basic steps are needed:

  1. Create a new branch
  2. Commit changes (if any) and remember about proper commit messages
  3. Create a new pull request
  4. A new version will be published when the PR is merged

CHANGELOG

You can find it here.

You can’t perform that action at this time.