improve usage example + docs

michael-spengler · Nov 6, 2021 · f730ea7 · f730ea7
1 parent b96faca
commit f730ea7
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 28 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,6 @@
+{
+    "deno.enable": true,
+    "deno.suggest.imports.hosts": {
+        "https://deno.land": false
+    }
+}
diff --git a/README.md b/README.md
@@ -5,24 +5,26 @@ fixed: https://github.com/denoland/deno/issues/1968
 
 ## Usage Example
 
+```sh
+
+deno run --allow-read --allow-net https://deno.land/x/time/usage-example.ts
+
+```
+
 ```ts
-import * as log from "https://deno.land/std/log/mod.ts";
-import { TimeService } from "https://deno.land/x/time";
+import * as log from "https://deno.land/std/log/mod.ts"
+import { TimeService } from "https://deno.land/x/time/mod.ts"
 
 const countryCode = "DE";
 const cityName = "Heidelberg";
 
-const time = await TimeService.getTimeByCountryAndCity(countryCode, cityName);
+const time = await TimeService.getTimeByCountryAndCity(countryCode, cityName)
+log.info(`In ${cityName} (${countryCode}) it is ${time} o'Clock :)`)
 
-log.info(`In ${cityName} (${countryCode}) it is ${time} o'Clock :)`);
-
-
-const timeZone = await TimeService.getTimeZone(countryCode, cityName);
-
-log.info(`The timezone of ${cityName} (${countryCode}) is ${timeZone}`);
-
+const timeZone = await TimeService.getTimeZone(countryCode, cityName)
+log.info(`The timezone of ${cityName} (${countryCode}) is ${timeZone}`)
 
-const timeByTimeZone = await TimeService.getTimeByTimeZone(timeZone);
+const timeByTimeZone = await TimeService.getTimeByTimeZone(timeZone)
 log.info(`In ${timeZone} it is ${timeByTimeZone} o'Clock :)`)
 
 ```
@@ -31,7 +33,7 @@ log.info(`In ${timeZone} it is ${timeByTimeZone} o'Clock :)`)
 
 ```sh
 
-deno test --allow-read https://deno.land/x/time/test.ts
+deno test --allow-read --allow-net https://deno.land/x/time/test.ts
 
 ```
 

diff --git a/time-service.ts b/time-service.ts
@@ -1,14 +1,13 @@
 import { Persistence } from "https://deno.land/x/persistence@1.1.0/persistence.ts"
-import * as log from "https://deno.land/std/log/mod.ts";
 
 export class TimeService {
 
 
     public static async getAllTimeZoneEntries(): Promise<any[]> {
         const pathToTimeZonesFile = 'https://raw.githubusercontent.com/michael-spengler/time/master/timezones.json'
-        
+
         const allTimeZoneEntries = JSON.parse(await Persistence.readFromRemoteFile(pathToTimeZonesFile))
-        
+
         return allTimeZoneEntries
     }
 
@@ -33,7 +32,7 @@ export class TimeService {
 
     public static async getTimeByTimeZone(timeZone: string): Promise<string> {
 
-        const allTimeZones = await TimeService.getAllTimeZoneEntries() 
+        const allTimeZones = await TimeService.getAllTimeZoneEntries()
 
         const entry = allTimeZones.filter((e: any) => e.timezone === timeZone)[0]
 
@@ -87,7 +86,7 @@ export class TimeService {
 
     private static async getTimeZoneEntry(countryCode: string, cityName: string): Promise<any> {
 
-        const allTimeZones = await TimeService.getAllTimeZoneEntries() 
+        const allTimeZones = await TimeService.getAllTimeZoneEntries()
 
         const entry = allTimeZones.filter((e: any) => e.iso2 === countryCode && (e.city === cityName || e.city_ascii === cityName))[0]
         if (entry === undefined) {

diff --git a/usage-example.ts b/usage-example.ts
@@ -1,18 +1,14 @@
-import * as log from "https://deno.land/std/log/mod.ts";
-import { TimeService } from "https://deno.land/x/time";
+import * as log from "https://deno.land/std/log/mod.ts"
+import { TimeService } from "https://deno.land/x/time/mod.ts"
 
 const countryCode = "DE";
 const cityName = "Heidelberg";
 
-const time = await TimeService.getTimeByCountryAndCity(countryCode, cityName);
+const time = await TimeService.getTimeByCountryAndCity(countryCode, cityName)
+log.info(`In ${cityName} (${countryCode}) it is ${time} o'Clock :)`)
 
-log.info(`In ${cityName} (${countryCode}) it is ${time} o'Clock :)`);
-  
+const timeZone = await TimeService.getTimeZone(countryCode, cityName)
+log.info(`The timezone of ${cityName} (${countryCode}) is ${timeZone}`)
 
-const timeZone = await TimeService.getTimeZone(countryCode, cityName);
-
-log.info(`The timezone of ${cityName} (${countryCode}) is ${timeZone}`);
-
-
-const timeByTimeZone = await TimeService.getTimeByTimeZone(timeZone);
+const timeByTimeZone = await TimeService.getTimeByTimeZone(timeZone)
 log.info(`In ${timeZone} it is ${timeByTimeZone} o'Clock :)`)