feat: get all supported calendars and currency (#20)

shivam-sharma7 · Oct 18, 2024 · 813cad0 · 813cad0
1 parent 0f39415
commit 813cad0
Show file tree

Hide file tree

Showing 5 changed files with 101 additions and 0 deletions.
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -12,6 +12,8 @@
 - [Get Current Time in Zone](./guide/getCurrentTimeInZone.md)
 - [Get list of Time Zones](./guide/getListOfSupportedTimeZones.md)
 - [Get Count Down To Event](./guide//getCountdownToEvent.md)
+- [Get list of calendar](./guide/getSupportedCalendar.md)
+- [Get list of Currency](./guide/getSupportedCrrency.md)
 - [Convert Time Zone](./guide/convertTimeZone.md)
 - [Time Zone Offset Difference](./guide/getTimeZoneOffsetDifference.md)
 - [Format Date in Time Zone](./guide/formatDateInTimeZone.md)

diff --git a/docs/guide/getSupportedCalendar.md b/docs/guide/getSupportedCalendar.md
@@ -0,0 +1,33 @@
+# Supported Timezones
+
+## Description
+
+This function returns a list of all supported calendars, making it easy to access and work with timezone data and calender.
+
+## Usage
+
+```javascript
+import { getSupportedCalendar } from 'world-clockify';
+
+const calendar = getSupportedCalendar();
+```
+
+## Expected Output
+
+```bash
+
+    'buddhist',      'chinese',
+  'coptic',        'dangi',
+  'ethioaa',       'ethiopic',
+  'gregory',       'hebrew',
+  'indian',        'islamic',
+  'islamic-civil', 'islamic-rgsa',
+  'islamic-tbla',  'islamic-umalqura',
+  'iso8601',       'japanese',
+  'persian',       'roc'
+
+```
+
+## Returns
+
+Returns: strings[], Array of string each representing supported calendar.
diff --git a/docs/guide/getSupportedCrrency.md b/docs/guide/getSupportedCrrency.md
@@ -0,0 +1,34 @@
+# Supported Currency
+
+## Description
+
+This function returns a list of all supported currencies, making it easy to access and work with currency data.
+
+## Usage
+
+```javascript
+import { getSupportedCrrency } from 'world-clockify';
+
+const currency = getSupportedCrrency();
+```
+
+## Expected Output
+
+```bash
+
+'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD',
+  'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF',
+  'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYN',
+  'BZD', 'CAD', 'CDF', 'CHF', 'CLP', 'CNY', 'COP', 'CRC',
+  'CUC', 'CUP', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD',
+  'EGP', 'ERN', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL',
+  'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL',
+  'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'IRR',
+  'ISK', 'JMD', 'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF',
+  ... more items
+
+```
+
+## Returns
+
+Returns: strings[], Array of string each representing supported currency.
diff --git a/src/function.ts b/src/function.ts
@@ -169,6 +169,26 @@ export const getSupportedTimezones = (): string[] => {
   return getListOfSupportedTimeZones;
 };
 
+/**
+ * Returns a list of all supported currency using the Javascript Intl API.
+ * @returns {string[]} - An array of supported currency strings.
+ */
+export const getSupportedCrrency = (): string[] => {
+  const getListOfSupportedCurrency = Intl.supportedValuesOf('currency');
+
+  return getListOfSupportedCurrency;
+};
+
+/**
+ * Returns a list of all supported calendar using the Javascript Intl API.
+ * @returns {string[]} - An array of supported calendar strings.
+ */
+export const getSupportedCalendar = (): string[] => {
+  const getListOfSupportedCalendar = Intl.supportedValuesOf('calendar');
+
+  return getListOfSupportedCalendar;
+};
+
 /**
  * Get the countdown to a specific event in a given timezone.
  *

diff --git a/tests/index.test.ts b/tests/index.test.ts
@@ -6,6 +6,8 @@ import {
   formatDateInTimeZone,
   calculateDuration,
   getSupportedTimezones,
+  getSupportedCrrency,
+  getSupportedCalendar,
   getCountdownToEvent,
 } from '../src/function.js';
 
@@ -71,6 +73,16 @@ describe('Timezone-Aware Date Helper', () => {
     expect(timezones).toBeInstanceOf(Array);
   });
 
+  it('should returns a list of all supported currency', () => {
+    const currencies = getSupportedCrrency();
+    expect(currencies).toBeInstanceOf(Array);
+  });
+
+  it('should returns a list of all supported calendar', () => {
+    const calenders = getSupportedCalendar();
+    expect(calenders).toBeInstanceOf(Array);
+  });
+
   it('should calculate the countdown to a specific event', () => {
     const eventDate = '2024-10-20T15:00:00';
     const eventTimezone = 'America/New_York';