feat: ✨ add examples and reduce dependencies

thkruz · Jan 11, 2024 · 64116c8 · 64116c8
1 parent 16c336b
commit 64116c8
Show file tree

Hide file tree

Showing 19 changed files with 174 additions and 765 deletions.
diff --git a/examples/README b/examples/README
diff --git a/examples/commonjs/README.md b/examples/commonjs/README.md
@@ -0,0 +1,3 @@
+Run the examples using node.
+
+Example: node ./examples/commonjs/satellite.js
diff --git a/examples/commonjs/satellite.js b/examples/commonjs/satellite.js
@@ -0,0 +1,12 @@
+const { Satellite } = require('../../lib/ootk-core');
+
+const tle1 = '1 25544U 98067A   19156.50900463  .00003075  00000-0  59442-4 0  9992';
+const tle2 = '2 25544  51.6433  59.2583 0008217  16.4489 347.6017 15.51174618173442';
+
+const satellite = new Satellite({
+  tle1,
+  tle2,
+});
+
+// eslint-disable-next-line no-console
+console.log(satellite.eci());
diff --git a/examples/mjs/README.md b/examples/mjs/README.md
@@ -0,0 +1,3 @@
+Run the examples using tsx.
+
+Example: npx tsx ./examples/satellite.mjs
diff --git a/examples/mjs/satellite.mjs b/examples/mjs/satellite.mjs
@@ -0,0 +1,12 @@
+import { Satellite } from '../../lib/ootk-core.mjs';
+
+const tle1 = '1 25544U 98067A   19156.50900463  .00003075  00000-0  59442-4 0  9992';
+const tle2 = '2 25544  51.6433  59.2583 0008217  16.4489 347.6017 15.51174618173442';
+
+const satellite = new Satellite({
+  tle1,
+  tle2,
+});
+
+// eslint-disable-next-line no-console
+console.log(satellite.eci());
diff --git a/examples/tsconfig.json b/examples/tsconfig.json
diff --git a/examples/typescript/README.md b/examples/typescript/README.md
@@ -0,0 +1,3 @@
+Run the examples using ts-node.
+
+Example: npx ts-node ./examples/julian.ts -p ./examples/tsconfig.json
diff --git a/examples/satellite-js-migration.ts → ...ples/typescript/satellite-js-migration.ts b/examples/satellite-js-migration.ts → ...ples/typescript/satellite-js-migration.ts
@@ -12,7 +12,7 @@ import {
   Sgp4,
   TleLine1,
   TleLine2,
-} from '../src/ootk-core';
+} from '../../src/ootk-core';
 
 // Sample TLE
 const tle1 = '1 25544U 98067A   19156.50900463  .00003075  00000-0  59442-4 0  9992' as TleLine1;

diff --git a/examples/sun.ts → examples/typescript/sun.ts b/examples/sun.ts → examples/typescript/sun.ts
@@ -1,4 +1,4 @@
-import { Degrees, Meters, Sun } from '../lib/ootk-core';
+import { Degrees, Meters, Sun } from '../../lib/ootk-core';
 /* eslint-disable no-console */
 
 console.log(Sun.getTimes(new Date(), 41 as Degrees, -71 as Degrees, 0 as Meters));
diff --git a/examples/transforms.ts → examples/typescript/transforms.ts b/examples/transforms.ts → examples/typescript/transforms.ts
@@ -1,5 +1,5 @@
 /* eslint-disable no-console */
-import { Degrees, ecf2rae, EcfVec3, GroundPosition, Kilometers, lla2ecf, lla2sez, RAD2DEG } from '../src/ootk-core';
+import { Degrees, ecf2rae, EcfVec3, GroundPosition, Kilometers, lla2ecf, lla2sez, RAD2DEG } from '../../src/ootk-core';
 
 const observer = new GroundPosition({
   name: 'ground-position',

diff --git a/examples/typescript/tsconfig.json b/examples/typescript/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "ES2015",
+    "baseUrl": "../"
+  }
+}