Merge pull request #13 from gammaaex/feature/create_declaration_file_for_typescript

Create declaration file for typescript

Author: k1LoW

README.md

@@ -16,14 +16,22 @@ In HTML
 <script src="./your/own/path/holiday_jp.js"></script>
 <script>
 var holidays = holiday_jp.between(new Date('2010-09-14'), new Date('2010-09-21'));
-console.log(holidays[0]['name']) // // 敬老の日
+console.log(holidays[0]['name']); // 敬老の日
 </script>
 ```
 
 In Node
 
 ```javascript
-var holiday_jp = require('holiday_jp');
+var holiday_jp = require('@holiday-jp/holiday_jp');
 var holidays = holiday_jp.between(new Date('2010-09-14'), new Date('2010-09-21'));
-console.log(holidays[0]['name']) // // 敬老の日
+console.log(holidays[0]['name']); // 敬老の日
+```
+
+In TypeScript
+
+```typescript
+import * as holiday_jp from '@holiday-jp/holiday_jp';
+const holidays = holiday_jp.between(new Date('2010-09-14'), new Date('2010-09-21'));
+console.log(holidays[0]['name']); // 敬老の日
 ```

lib/holiday_jp.d.ts

@@ -0,0 +1,46 @@
+/**
+ * The type definition of a holiday
+ * @see https://github.com/holiday-jp/holiday_jp-js/blob/master/lib/holidays.js
+ */
+export interface Holiday {
+  /**
+   * Expression of Date object
+   */
+  date: Date;
+  /**
+   * Day of the week in Japanese
+   */
+  week: string;
+  /**
+   * Day of the week in English
+   */
+  week_en: string;
+  /**
+   * Holiday name in Japanese
+   */
+  name: string;
+  /**
+   * Holiday name in English
+   */
+  name_en: string;
+}
+
+/**
+ * The version of this package
+ */
+export const VERSION: string
+
+/**
+ * Find holidays between parameters
+ * @param start Start date to find holiday
+ * @param end End date to find holiday
+ * @returns The holiday list between start and end, or empty if none
+ */
+export function between(start: Date, end: Date): Holiday[];
+
+/**
+ * Check if parameter is holiday
+ * @param date A reference to be checked against holiday
+ * @returns True if the provided reference is holiday otherwise false
+ */
+export function isHoliday(date: Date): boolean;

package.json

@@ -3,6 +3,7 @@
   "version": "2.2.2",
   "description": "Japanese holidays",
   "main": "release/holiday_jp.js",
+  "types": "lib/holiday_jp.d.ts",
   "scripts": {
     "test": "mocha --require should test/*.js",
     "generate": "git submodule update; cd holiday_jp/; git fetch origin master; git reset --hard origin/master; cd ../; node scripts/generate.js",