Merge pull request #106 from github/add-flow-definition-file

Add flow definition file
github · May 16, 2019 · 2582f90 · 2582f90
2 parents 4e6f95a + be1f354
commit 2582f90
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 6 deletions.
diff --git a/package.json b/package.json
@@ -5,11 +5,13 @@
   "module": "dist/time-elements.js",
   "license": "MIT",
   "scripts": {
-    "clean": "rm -rf ./dist ./node_modules",
+    "clean": "rm -rf dist",
     "lint": "github-lint",
-    "build": "rollup -c",
+    "prebuild": "npm run clean && npm run lint && mkdir dist",
+    "build": "rollup -c && cp src/index.js.flow dist/time-elements.js.flow && cp src/index.js.flow dist/time-elements-legacy.js.flow",
     "prepublishOnly": "npm run pretest",
-    "pretest": "npm run lint && npm run build",
+    "pretest": "npm run build",
+    "prepublishOnly": "npm run build",
     "test": "karma start ./test/karma.config.js"
   },
   "repository": "github/time-elements",

diff --git a/src/index.js.flow b/src/index.js.flow
@@ -0,0 +1,24 @@
+/* flow strict */
+
+declare module 'time-elements' {
+  declare class ExtendedTimeElement extends HTMLElement {
+    getFormattedTitle(): ?string;
+    getFormattedDate(): ?string;
+  }
+
+  declare export class LocalTimeElement extends ExtendedTimeElement {
+    getFormattedDate(): ?string;
+  }
+
+  declare export class RelativeTimeElement extends ExtendedTimeElement {
+    getFormattedDate(): ?string;
+  }
+
+  declare export class TimeAgoElement extends RelativeTimeElement {
+    getFormattedDate(): ?string;
+  }
+
+  declare export class TimeUntilElement extends RelativeTimeElement {
+    getFormattedDate(): ?string;
+  }
+}
diff --git a/src/relative-time-element.js b/src/relative-time-element.js
@@ -4,7 +4,7 @@ import RelativeTime from './relative-time'
 import ExtendedTimeElement from './extended-time-element'
 
 export default class RelativeTimeElement extends ExtendedTimeElement {
-  getFormattedDate() {
+  getFormattedDate(): ?string {
     if (this._date) {
       return new RelativeTime(this._date).toString()
     }

diff --git a/src/time-ago-element.js b/src/time-ago-element.js
@@ -4,7 +4,7 @@ import RelativeTime from './relative-time'
 import RelativeTimeElement from './relative-time-element'
 
 export default class TimeAgoElement extends RelativeTimeElement {
-  getFormattedDate() {
+  getFormattedDate(): ?string {
     const format = this.getAttribute('format')
     if (!this._date) return
     if (format === 'micro') {

diff --git a/src/time-until-element.js b/src/time-until-element.js
@@ -4,7 +4,7 @@ import RelativeTime from './relative-time'
 import RelativeTimeElement from './relative-time-element'
 
 export default class TimeUntilElement extends RelativeTimeElement {
-  getFormattedDate() {
+  getFormattedDate(): ?string {
     const format = this.getAttribute('format')
     if (!this._date) return
     if (format === 'micro') {