feat: get all supported timezones list (#10)

* feat: get all supported timezones list

* v1.3.2

docs/_sidebar.md

@@ -10,6 +10,7 @@
 <summary>How to Use</summary>
 
 - [Get Current Time in Zone](./guide/getCurrentTimeInZone.md)
+- [Get list of Time Zones](./guide/getListOfSupportedTimeZones.md)
 - [Convert Time Zone](./guide/convertTimeZone.md)
 - [Time Zone Offset Difference](./guide/getTimeZoneOffsetDifference.md)
 - [Format Date in Time Zone](./guide/formatDateInTimeZone.md)

docs/guide/getListOfSupportedTimeZones.md

@@ -0,0 +1,34 @@
+# Supported Timezones
+
+## Description
+
+This function returns a list of all supported IANA timezones, making it easy to access and work with timezone data.
+
+## Usage
+
+```javascript
+import { getSupportedTimezones } from 'world-clockify';
+
+const timezones = getSupportedTimezones();
+```
+
+## Expected Output
+
+```bash
+
+   Africa/Abidjan',
+  'Africa/Accra',
+  'Africa/Addis_Ababa',
+  'Africa/Algiers',
+  'Africa/Asmera',
+  'Africa/Bamako',
+  'Africa/Bangui',
+  'Africa/Banjul',
+  'Africa/Bissau',
+  ... more items
+
+```
+
+## Returns
+
+Returns: strings[], Array of string each representing a valid IANA timezone.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "world-clockify",
-  "version": "1.1.2",
+  "version": "1.3.2",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",
   "types": "./dist/index.d.ts",
@@ -13,6 +13,7 @@
   },
   "files": [
     "dist",
+    "docs",
     "src",
     "LICENSE",
     "REDME.md"
@@ -24,7 +25,7 @@
     "zone",
     "converter"
   ],
-  "homepage": "https://github.com/shivam-sharma7/world-clockify",
+  "homepage": "https://shivam-sharma7.github.io/world-clockify/#/",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/shivam-sharma7/world-clockify.git"

src/function.ts

@@ -172,3 +172,14 @@ export const calculateDuration = (
 
   return duration;
 };
+
+/**
+ * Returns a list of all supported IANA timezones using the Javascript Intl API.
+ * @returns {string[]} - An array of supported timezone strings.
+ */
+export const getSupportedTimezones = (): string[] => {
+  const getListOfSupportedTimeZones = Intl.supportedValuesOf('timeZone');
+  console.log('Get all all supported IANA timezones', getListOfSupportedTimeZones);
+
+  return getListOfSupportedTimeZones;
+};

tests/index.test.ts

@@ -5,6 +5,7 @@ import {
   getTimeDifference,
   formatDateInTimeZone,
   calculateDuration,
+  getSupportedTimezones,
 } from '../src/function.js';
 
 describe('Timezone-Aware Date Helper', () => {
@@ -63,4 +64,9 @@ describe('Timezone-Aware Date Helper', () => {
     expect(durationInHours).toBe(72); // 3 days * 24 hours = 72 hours
     expect(durationInMinutes).toBe(4320); // 72 hours * 60 minutes = 4320 minutes
   });
+
+  it('should returns a list of all supported IANA timezones', () => {
+    const timezones = getSupportedTimezones();
+    expect(timezones);
+  });
 });