Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
address-validation-autocomplete
Advanced tools
address-validation-autocomplete - npm Package Compare versions
Comparing version 0.0.0 to 0.0.1
| { | ||
| "name": "address-validation-autocomplete", | ||
| "version": "0.0.0", | ||
| "version": "0.0.1", | ||
| "description": "Real-time, International Address Validation & Autocomplete. Simple JSON API For Seamless Address Data Processing", | ||
@@ -5,0 +5,0 @@ "repository": { |
140
README.md
| [](Travis) | ||
| [](Travis) | ||
| Node JavaScript wrapper for [the numverify API](https://numverify.com/). | ||
| Node JavaScript wrapper for [the streetlayer API](https://streetlayer.com). | ||
@@ -10,137 +10,5 @@ Supports both traditional callbacks and Promises/A+. | ||
| ## Installation | ||
| npm install phone-number-validation [--save] | ||
| ## Configuration | ||
| Before using the numverify API client you have to setup your account and obtain your API Access Key. | ||
| You can get it by signing up at [https://numverify.com/product](https://numverify.com/product). | ||
| --- | ||
| ## Usage | ||
| The general API is documented here: [https://numverify.com/documentation](https://numverify.com/documentation). | ||
| You can find parameters, result set definitions and status codes documented here as well. | ||
| ### Setup | ||
| var API = require('phone-number-validation'); | ||
| var api = new API({ | ||
| access_key: [ACCESS_KEY], | ||
| secure: [true|false] (Optional, defaults to false) | ||
| }); | ||
| #### Optional Parameters | ||
| ##### Secure (only available for Basic, Pro and Enterprise accounts) | ||
| Boolean value to indicate if the calls to the API should use a secure protocol or insecure (HTTP/HTTPS). Defaults to false (HTTP, insecure). | ||
| --- | ||
| ## Callbacks vs. Promises | ||
| The Promises/A+ implementation used for this is this excellent bare bones library: | ||
| [https://www.npmjs.com/package/promise](https://www.npmjs.com/package/promise) | ||
| The phone-number-validation library supports either mode and use of either one is not mutually exclusive to the alternative, so it's possible to use one exclusively or a combination, even in the same call, both the callback will be called and the promise handlers invoked. | ||
| --- | ||
| ## API Overview | ||
| All endpoints in the public API is available through this library. | ||
| - validate | ||
| - countries | ||
| --- | ||
| ## validate | ||
| Takes an email and checks the email against the API. | ||
| ###### Define Query | ||
| var query = { | ||
| number: '14158586273' | ||
| }; | ||
| ###### Simple Request (using Callback) | ||
| api.validate(query, function (err, result) { | ||
| if (err) { | ||
| return console.log('Validate Callback (Error): ' + JSON.stringify(err)); | ||
| } | ||
| console.log('Validate Callback (Success): ' + JSON.stringify(result)); | ||
| }); | ||
| ###### Response | ||
| ``` | ||
| { | ||
| "valid": true, | ||
| "number": "14158586273", | ||
| "local_format": "4158586273", | ||
| "international_format": "+14158586273", | ||
| "country_prefix": "+1", | ||
| "country_code": "US", | ||
| "country_name": "United States of America", | ||
| "location": "Novato", | ||
| "carrier": "AT&T Mobility LLC", | ||
| "line_type": "mobile" | ||
| } | ||
| ``` | ||
| ## countries | ||
| Fetches all supported countries | ||
| ###### Simple Request (using Callback) | ||
| api.countries(function (err, result) { | ||
| if (err) { | ||
| return console.log('Countries Callback (Error): ' + JSON.stringify(err)); | ||
| } | ||
| console.log('Countries Callback (Success): ' + JSON.stringify(result)); | ||
| }); | ||
| ###### Response | ||
| ``` | ||
| { | ||
| "AF": { | ||
| "country_name": "Afghanistan", | ||
| "dialling_code": "+93" | ||
| }, | ||
| "AL": { | ||
| "country_name": "Albania", | ||
| "dialling_code": "+355" | ||
| }, | ||
| "DZ": { | ||
| "country_name": "Algeria", | ||
| "dialling_code": "+213" | ||
| }, | ||
| ... | ||
| } | ||
| ``` | ||
| --- | ||
| ## Example Application | ||
| In the [rootdir]/example directory there is a fully functional application which runs all requests against all the endpoints in the API, the examples above can be seen there as source code. | ||
| The example application uses a process.env variable to hold the access key. | ||
| For running in development environments, it's easy to use the [https://www.npmjs.com/package/dotenv](https://www.npmjs.com/package/dotenv) to load variables from a local file into the environment. | ||
| --- | ||
| ## Tests | ||
| The tests are written for any NodeJS testing library, but has been run and targeted at the [https://mochajs.org/](https://mochajs.org/) testing library. | ||
| --- | ||
| ## Customer Support | ||
| Need any assistance? [Get in touch with Customer Support](mailto:support@apilayer.net?subject=%numverify%5D). | ||
| Need any assistance? [Get in touch with Customer Support](mailto:support@apilayer.net?subject=%streetlayer%5D). | ||
@@ -168,3 +36,3 @@ --- | ||
| Copyright (©) 2016 Peter Andreas Moelgaard & apilayer | ||
| Copyright (©) 2017 Peter Andreas Moelgaard & apilayer | ||
@@ -171,0 +39,0 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: |
Sorry, the diff of this file is not supported yet
No alert changes
Worsened metrics
- Total package byte prevSize
- decreased by-19.87%
13997
- Number of lines in readme file
- decreased by-76.3%
41
No dependency changes