Merge pull request #12 from bradmartin/master

TypeScript definition/examples

README.md

@@ -91,3 +91,28 @@ phone.sms(["212-555-1234","212-555-1245"],"My Message")
     }
 );
 ```
+
+
+### TypeScript example
+
+```TypeScript
+
+import * as TNSPhone from 'nativescript-phone';
+
+/// Dial a phone number.
+public callHome() {
+    TNSPhone.dial('415-123-4567', false);
+}
+
+// Text a number (or multiple numbers)
+public messageParents() {
+    TNSPhone.sms(['212-555-1234', '212-555-0987'], "Text till your fingers bleed")
+        .then((args) => {
+            console.log(JSON.stringify(args));
+        }, (err) => {
+            console.log('Error: ' + err);
+        })
+}
+
+
+```

index.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Initiate a phone call.
+ * @param {string} number - The number to dial.
+ * @param {boolean} confirm - To enable OS specific confirmation before dialing.
+ */
+export function dial(number: string, confirm: boolean);
+
+
+/**
+ * Open the OS specific SMS app.
+ * @param {Array<string>} numbers - The number to send SMS to.
+ * @param {string} message - The message to send.
+ */
+export function sms(numbers: Array<string>, message: string): Promise<response>;
+
+
+interface response {
+    "success": string,
+    "cancelled": string,
+    "failed": string
+}

package.json

@@ -3,6 +3,7 @@
 	"version": "1.1.0",
 	"description": "A phone NativeScript module for Android and iOS",
 	"main": "index.js",
+	"typings": "index.d.ts",
 	"repository": {
 		"type": "git",
 		"url": "https://github.com/msywensky/nativescript-phone.git"
@@ -11,6 +12,13 @@
 		"NativeScript"
 	],
 	"author": "Mike Sywensky <[email protected]> ",
+	"contributors": [
+		{
+			"name": "Brad Martin",
+			"email": " [email protected]",
+			"url": "https://github.com/bradmartin"
+		}
+	],
 	"license": {
 		"type": "MIT",
 		"url": "https://github.com/msywensky/nativescript-phone/blob/master/LICENSE"
@@ -25,4 +33,4 @@
 			"ios": "1.0.0"
 		}
 	}
-}
+}