feat(ics): allow providing .ics filename, without relying on title

jshor · Jan 5, 2021 · 9fc3314 · 9fc3314
1 parent ad356ed
commit 9fc3314
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 4 deletions.
diff --git a/docs/docs/icalendar.md b/docs/docs/icalendar.md
@@ -178,6 +178,8 @@ DTSTAMP:20200916
 PRODID:datebook.dev
 ```
 
-## `download()`
+## `download(fileName?: string)`
+
+* **`fileName: string`** - optional file name
 
 Downloads a `.ics` file on the user's browser for use in local calendars and email clients.
diff --git a/src/ICalendar.ts b/src/ICalendar.ts
@@ -131,10 +131,10 @@ export default class ICalendar extends CalendarBase {
    *
    * @remark Only works in browsers.
    *
-   * @param {string} filename optional explicit filename, if not provided then will be constructed from title
+   * @param {string} fileName optional explicit file name, if not provided then will be constructed from title
    */
-  public download = (filename?: string): void => {
-    ics.download(filename || ics.getFileName(this.title), this.render())
+  public download = (fileName?: string): void => {
+    ics.download(fileName || ics.getFileName(this.title), this.render())
   }
 
   /**