docs: added docstrings and updated README [skip ci]

slipmatio · Nov 30, 2024 · 577d8a3 · 577d8a3
1 parent 550dcfc
commit 577d8a3
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -9,8 +9,10 @@ General utilities for Web development
 ### Browser
 
 - `browserIsIE()`
+- `browserIsSupported()`
 - `copyToClipboard(content: string)`
 - `getCookie(name: string)`
+- `hasTimeZoneSupport()`
 - `isValidSecureUrl(url: string)`
 - `prefetchImages(url: string|string[])`
 - `storageAvailable(type: 'localStorage' | 'sessionStorage')`

diff --git a/src/browser.ts b/src/browser.ts
@@ -168,6 +168,9 @@ export function browserIsIE() {
   return ua.indexOf('MSIE ') > -1 || ua.indexOf('Trident/') > -1
 }
 
+/**
+ * Returns true if the browser has modern timezone support, localStorage is available and is not IE.
+ */
 export function browserIsSupported() {
   if (isSSR()) {
     return false