add typescript examples

ci/scripts/run-all-examples.sh

@@ -1,10 +1,19 @@
 set -e
 
-echo "running all examples"
+echo "running all JS examples"
 echo "--------------------"
 
-for example in examples/*; do
+for example in examples/js/*; do
   echo "running $(basename $example .js)"
   node $example
   echo "--------------------"
 done
+
+echo "running all TS examples"
+echo "--------------------"
+
+for example in examples/ts/*; do
+  echo "running $(basename $example .ts)"
+  npx ts-node $example
+  echo "--------------------"
+done

examples/availability.js → examples/js/availability.js

@@ -1,7 +1,7 @@
 // obtain a reference to the module
 // when using the module in your project, this line would be
-// const traffic = require('ukpd')
-const UKPD = require('../build')
+// const UKPD = require('ukpd')
+const UKPD = require('../../build')
 
 async function main () {
   const result = await UKPD.availability()

examples/categories.js → examples/js/categories.js

@@ -1,7 +1,7 @@
 // obtain a reference to the module
 // when using the module in your project, this line would be
-// const traffic = require('ukpd')
-const UKPD = require('../build')
+// const UKPD = require('ukpd')
+const UKPD = require('../../build')
 
 async function main () {
   const result = await UKPD.categories()

examples/forces.js → examples/js/forces.js

@@ -1,7 +1,7 @@
 // obtain a reference to the module
 // when using the module in your project, this line would be
-// const traffic = require('ukpd')
-const UKPD = require('../build')
+// const UKPD = require('ukpd')
+const UKPD = require('../../build')
 
 async function main () {
   const result = await UKPD.forces()

examples/last-updated.js → examples/js/last-updated.js

@@ -1,7 +1,7 @@
 // obtain a reference to the module
 // when using the module in your project, this line would be
-// const traffic = require('ukpd')
-const UKPD = require('../build')
+// const UKPD = require('ukpd')
+const UKPD = require('../../build')
 
 async function main () {
   const result = await UKPD.lastUpdated()

examples/stop-and-search.js → examples/js/stop-and-search.js

@@ -1,7 +1,7 @@
 // obtain a reference to the module
 // when using the module in your project, this line would be
-// const traffic = require('ukpd')
-const UKPD = require('../build')
+// const UKPD = require('ukpd')
+const UKPD = require('../../build')
 
 async function main () {
   const results = await UKPD.stopAndSearch('cheshire')

examples/street-level.js → examples/js/street-level.js

@@ -1,7 +1,7 @@
 // obtain a reference to the module
 // when using the module in your project, this line would be
-// const traffic = require('ukpd')
-const UKPD = require('../build')
+// const UKPD = require('ukpd')
+const UKPD = require('../../build')
 
 async function main () {
   const results = await UKPD.streetLevel(52.629729, -1.131592)

examples/ts/availability.ts

@@ -0,0 +1,14 @@
+// obtain a reference to the module
+// when using the module in your project, this line would be
+// import * as UKPD from 'ukpd'
+import * as UKPD from '../../build'
+
+async function main () {
+  const result = await UKPD.availability()
+
+  const dates = result.map((item) => item.date)
+
+  console.log('data is available for', dates.join(', '))
+}
+
+main()

examples/ts/categories.ts

@@ -0,0 +1,14 @@
+// obtain a reference to the module
+// when using the module in your project, this line would be
+// import * as UKPD from 'ukpd'
+import * as UKPD from '../../build'
+
+async function main () {
+  const result = await UKPD.categories()
+
+  const categories = result.map((category) => category.name)
+
+  console.log('the following categories are available:', categories.join(', '))
+}
+
+main()

examples/ts/forces.ts

@@ -0,0 +1,15 @@
+// obtain a reference to the module
+// when using the module in your project, this line would be
+// import * as UKPD from 'ukpd'
+import * as UKPD from '../../build'
+
+async function main () {
+  const result = await UKPD.forces()
+
+  const forcesArray = Array.isArray(result) ? result : [result]
+  const forces = forcesArray.map((force) => force.name)
+
+  console.log('data for the following police forces are available:', forces.join(', '))
+}
+
+main()

examples/ts/last-updated.ts

@@ -0,0 +1,12 @@
+// obtain a reference to the module
+// when using the module in your project, this line would be
+// import * as UKPD from 'ukpd'
+import * as UKPD from '../../build'
+
+async function main () {
+  const result = await UKPD.lastUpdated()
+
+  console.log('data was last updated on', result.date)
+}
+
+main()

examples/ts/stop-and-search.ts

@@ -0,0 +1,12 @@
+// obtain a reference to the module
+// when using the module in your project, this line would be
+// import * as UKPD from 'ukpd'
+import * as UKPD from '../../build'
+
+async function main () {
+  const results = await UKPD.stopAndSearch('cheshire')
+
+  console.log('there were', results.length, 'stop and searches')
+}
+
+main()

examples/ts/street-level.ts

@@ -0,0 +1,12 @@
+// obtain a reference to the module
+// when using the module in your project, this line would be
+// import * as UKPD from 'ukpd'
+import * as UKPD from '../../build'
+
+async function main () {
+  const results = await UKPD.streetLevel(52.629729, -1.131592)
+
+  console.log('there were', results.length, 'crimes')
+}
+
+main()