Add today method

README.md

@@ -1 +1,44 @@
 # nevnap
+
+Névnap is a minimalist JavaScript library that displays hungarian namedays.
+
+## Installation
+
+```
+npm i nevnap
+```
+
+## API
+
+### Methods
+
+#### `today(): string`
+
+Getting namedays on the current day.
+
+```javascript
+import { today } from 'nevnap';
+
+today(); // Tamás
+```
+
+
+#### `on(date: string): string`
+
+Getting namedays on a specific date.
+
+```javascript
+import { on } from 'nevnap';
+
+on('04-22'); // Csilla, Noémi
+```
+
+#### `to(name: string): string`
+
+Getting date on a specific name.
+
+```javascript
+import { to } from 'nevnap';
+
+to('Csilla'); // 04-22
+```

package.json

@@ -20,7 +20,11 @@
 		"url": "git+https://github.com/nevadavid/nevnap.git"
 	},
 	"author": "David Uri",
-	"license": "ISC",
+	"keywords": [
+		"namedays",
+		"typescript"
+	],
+	"license": "MIT",
 	"bugs": {
 		"url": "https://github.com/nevadavid/nevnap/issues"
 	},

src/index.ts

@@ -4,15 +4,27 @@ function getNumberFromIndex(index: number) {
 	return `${index + 1}`.padStart(2, '0');
 }
 
-export function on(date: string) {
+/**
+ * Getting namedays on a specific date.
+ *
+ * @param {string} date
+ * @returns {string}
+ */
+export function on(date: string): string {
 	const [month, day] = date.split('-');
 	const monthIndex = parseInt(month, 10) - 1;
 	const dayIndex = parseInt(day, 10) - 1;
 
 	return namedays[monthIndex][dayIndex];
 }
 
-export function to(name: string) {
+/**
+ * Getting date on a specific name.
+ *
+ * @param {string} name
+ * @returns {string}
+ */
+export function to(name: string): string | undefined {
 	for (const [monthIndex, month] of namedays.entries()) {
 		for (const [dayIndex, day] of month.entries()) {
 			const names = day.split(',');
@@ -26,3 +38,16 @@ export function to(name: string) {
 		}
 	}
 }
+
+/**
+ * Getting namedays on the current day.
+ *
+ * @returns {string}
+ */
+export function today(): string {
+	const now = new Date();
+	const month = now.getMonth();
+	const day = now.getDate();
+
+	return namedays[month][day - 1];
+}

tsconfig.json

@@ -10,7 +10,8 @@
 		"strict": true,
 		"declaration": true,
 		"esModuleInterop": true,
-		"downlevelIteration": true
+		"downlevelIteration": true,
+		"sourceMap": true
 	},
 	"include": [
 		"src/**/*",