@flybywiresim/api-client - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0

lib/index.d.ts

@@ -93,2 +93,3 @@ export declare class MetarResponse {
 }
+export declare type StageCallback = (flights: TelexConnection[]) => void;
 export declare class HttpError extends Error {
@@ -122,2 +123,3 @@ readonly status: number;
     static fetchConnections(skip?: number, take?: number, bounds?: Bounds): Promise<Paginated<TelexConnection>>;
+    static fetchAllConnections(bounds?: Bounds, stageCallback?: StageCallback): Promise<TelexConnection[]>;
     static fetchConnection(id: string): Promise<TelexConnection>;
@@ -124,0 +126,0 @@ static findConnection(flightNumber: string): Promise<TelexConnection>;

lib/index.js

@@ -15,2 +15,38 @@ "use strict";
 })();
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
 Object.defineProperty(exports, "__esModule", { value: true });
@@ -215,2 +251,30 @@ exports.GitVersions = exports.Airport = exports.Telex = exports.Taf = exports.Atis = exports.Metar = exports.NXApi = exports.TelexNotConnectedError = exports.HttpError = void 0;
     };
+    Telex.fetchAllConnections = function (bounds, stageCallback) {
+        return __awaiter(this, void 0, void 0, function () {
+            var flights, skip, total, data;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        flights = [];
+                        skip = 0;
+                        total = 0;
+                        _a.label = 1;
+                    case 1: return [4 /*yield*/, Telex.fetchConnections(skip, 100, bounds)];
+                    case 2:
+                        data = _a.sent();
+                        total = data.total;
+                        skip += data.count;
+                        flights = flights.concat(data.results);
+                        if (stageCallback) {
+                            stageCallback(flights);
+                        }
+                        _a.label = 3;
+                    case 3:
+                        if (total > skip) return [3 /*break*/, 1];
+                        _a.label = 4;
+                    case 4: return [2 /*return*/, flights];
+                }
+            });
+        });
+    };
     Telex.fetchConnection = function (id) {
@@ -217,0 +281,0 @@ var url = new URL("/txcxn/" + id, NXApi.url);

package.json

 {
   "name": "@flybywiresim/api-client",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Client library for the FlyByWire Simulations API",
@@ -30,2 +30,3 @@ "main": "lib/index.js",
   "devDependencies": {
+    "@types/es6-promise": "^3.3.0",
     "prettier": "^2.1.2",
@@ -32,0 +33,0 @@ "tslint": "^6.1.3",

README.md

@@ -182,3 +182,3 @@ # <img src="https://raw.githubusercontent.com/flybywiresim/fbw-branding/master/svg/FBW-Logo.svg" placeholder="FlyByWire" width="400"/>
 
-#### Fetch all active connections
+#### Fetch a single page of active connections
 ```ts
@@ -201,2 +201,17 @@ import { Telex } from '@flybywiresim/api-client';
 
+#### Fetch all active connections
+```ts
+import { Telex } from '@flybywiresim/api-client';
+
+Telex.fetchAllConnections(bounds, callback)
+  .then(data => {
+    console.log(data);
+  }).catch(err => {
+    console.error(err);
+});
+```
+
+- `bounds` is an optional bounding box. Query only connections within this area.
+- `callback` gets called after every fetched page.
+
 #### Fetch a certain connection
@@ -203,0 +218,0 @@ ```ts

No alert changes

Improved metrics

Total package byte prevSize

26038

increased by19.35%

Lines of code

522

increased by14.47%

Number of lines in readme file

260

increased by6.12%

Worsened metrics

Dev dependency count

5

increased by25%

No dependency changes