navigraph

Navigraph SDK

The Navigraph SDK for TypeScript/JavaScript implementations of Navigraph APIs and services.

Getting Started »

Installation

Warning The SDK is currently in very early development and is still subject to change. Please keep this in mind when using it.

Yarn

yarn add navigraph

NPM

npm i -S navigraph

Usage

For a full example implementation, see /examples/getting-started/.

import { initializeApp, Scope } from "navigraph/app";
import { getAuth } from "navigraph/auth";
import { getChartsAPI } from "navigraph/charts";

const config: NavigraphApp = {
  clientId: "<YOUR_NAVIGRAPH_CLIENT_ID>",
  clientSecret: "<YOUR_NAVIGRAPH_CLIENT_SECRET>",
  scopes: [Scope.CHARTS /* Additional scopes here */],
};

initializeApp(config);

export const auth = getAuth();
export const charts = getChartsAPI();

auth.signInWithDeviceFlow((params) =>
  /* Show params.verification_uri_complete as a QR code, scan it, sign in */
)

charts.getChartsIndex({ icao: "KJFK" }).then(console.log) // => { "charts": [{ "index_number": "10-1P" ...

Note A full reference will make its way to our developer documentation website in the future. In the meantime, please reference this usage section along with the Getting Started guide!

Supported environments

This library aims to be compatible with Coherent GT, as implemented by Microsoft Flight simulator. According to Coherent their environment is similar to Safari 10.1.2 (STP 34), so by supporting this environment we should be supporting any modern environment as well, both Node and browser.

License

Distributed under the MIT License. See LICENSE for more information.