tg-resolve - npm Package Compare versions

Comparing version 1.3.0 to 1.3.1

package.json

 {
   "name": "tg-resolve",
-  "version": "1.3.0",
+  "version": "1.3.1",
   "description": "Resolves Telegram usernames and/or ids to a complete User or/and Chat JSON object(s)",
@@ -20,3 +20,3 @@ "main": "index.js",
   "dependencies": {
-    "request": "^2.76.0"
+    "request": "^2.79.0"
   },
@@ -23,0 +23,0 @@ "contributors": [

README.md

 [![](https://img.shields.io/npm/dt/tg-resolve.svg?style=flat-square)](https://www.npmjs.com/package/tg-resolve)
 [![https://telegram.me/kamikazechaser](https://img.shields.io/badge/%F0%9F%92%AC_Telegram-kamikazechaser-blue.svg?style=flat-square)](https://telegram.me/kamikazechaser)
-[![https://github.com/kamikazechaser/rangi/blob/master/LICENSE.md](https://img.shields.io/badge/license-MIT-lightgreen.svg?style=flat-square)](https://github.com/kamikazechaser/rangi/blob/master/LICENSE)
-[![Gemnasium](https://img.shields.io/gemnasium/kamikazechaser/tg-resolve.svg?style=flat-square)](https://gemnasium.com/kamikazechaser/tg-resolve)
 [![Travis](https://img.shields.io/travis/kamikazechaser/tg-resolve.svg?style=flat-square)](https://travis-ci.org/kamikazechaser/tg-resolve)
@@ -10,3 +8,3 @@ > 👤 tg-resolve
 
-> Powered by pwrtelegramapi
+> Powered by [PWRTelegram API](http://pwrtelegram.xyz/)
 
@@ -28,3 +26,3 @@ ## Background
 ```bash
-npm i tg-resolve -S
+$ npm install tg-resolve --save
 ```
@@ -34,19 +32,70 @@
 
+```js
+const tgresolve = require("tg-resolve");
+
+// using the 'bare' function
+tgresolve(token, "@kamikazechaser", function(error, result) {
+    // ... handle error ...
+    console.log(result.id);
+});
+
+// you can create a client (referred to as 'resolver')
+// that you can repeatedly use
+const resolver = new tgresolver.Tgresolve(token);
+
+// using the 'resolver'
+resolver.tgresolve("@kamikazechaser", function(error, result) {
+    // ... handle error ...
+    console.log(result.id);
+});
+```
+
 _Refer to [example.js](https://github.com/kamikazechaser/tg-resolve/blob/master/example.js) for a more comprehensive guide_
 
 - As of v1.2.0, you will need your own bot token!
+- As of v1.3.0, you can pass in your own pwrtg url!
 
-## JSON Object Structure
 
+<a name="above-main"></a>
+#### tgresolve(token, username[, options], callback)
+
+Resolve the `username` to a [Result](#result).
+
+* **token** (String): Telegram bot token
+* **username** (String)
+* **options** (Object, Optional)
+    * **url** (String): custom [PWRTelegram API](http://pwrtelegram.xyz/) URL
+* **callback** (Function):
+    * signature: `callback(error, result)`
+
+
+#### resolver = new tgresolve.Tgresolve(token[, options])
+
+Create a client/resolver.
+
+* **token** (String): Telegram bot token
+* **options** (Object, Optional): same as [above](#above-main)
+
+
+#### resolver.tgresolve(username, callback)
+
+Resolve the `username` to a [Result](#result), using the client.
+
+* **username** (String)
+* **callback** (Function): same as [above](#above-main)
+
+
+<a name="result"></a>
+## Result
+
 _When resolving for a Group/Channel_
 
-```javascript
+```js
 {
-id: -1001065761006,
-title: "End Of The World Party",
-username: "EOTWGroup",
-type: "supergroup",
-when: "2016-10-18 11:22:56"
+    id: -1001065761006,
+    title: "End Of The World Party",
+    username: "EOTWGroup",
+    type: "supergroup",
+    when: "2016-10-18 11:22:56"
 }
-
 ```
@@ -56,14 +105,16 @@
 
-```javascript
+```js
 {
-id: 58258161,
-first_name: "John",
-username: "john_doe",
-type: "private",
-last_name: "Doe",
-when: "2016-10-18 11:22:56"
+    id: 58258161,
+    first_name: "John",
+    username: "john_doe",
+    type: "private",
+    last_name: "Doe",
+    when: "2016-10-18 11:22:56"
 }
 ```
+
+
 ## Issues And Contribution
 
 Fork the repository and submit a pull request for whatever change you want to be added to this project. If you have any questions, just open an issue.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

11399

increased by10.48%

Number of lines in readme file

117

increased by77.27%

Dependency changes

• Updatedrequest@^2.79.0