node-virustotal
Advanced tools
Comparing version 0.1.0 to 0.1.1
{ | ||
"name": "node-virustotal", | ||
"version": "0.1.0", | ||
"version": "0.1.1", | ||
"description": "An implementation of the Virustotal API for Node.js", | ||
@@ -5,0 +5,0 @@ "main": "code.js", |
@@ -31,1 +31,32 @@ # node-virustotal | ||
This function makes a new public connection object, using public API version 2. | ||
### PublicConnection.setKey() | ||
This function takes a hexadecimal string, and attempts to use said string as the API key for tasks in the queue. | ||
### PublicConnection.getKey() | ||
This function returns the key that the connection is currently using. | ||
### PublicConnection.setDelay() | ||
This function takes an integer, sets the delay between any two jobs performed by the connection object to said integer. By default, this is 15000 milliseconds. This should not be changed unless you have specific permission from VirusTotal. | ||
### PublicConnection.getDelay() | ||
This function returns the delay between any two jobs performed by the connection. By default, this is 15000. | ||
### PublicConnection.checkIPv4() | ||
This function takes 3 parameters: an IPv4 address, a function to perform if a result is obtained, and a function to perform if an error is obtained. The two functions both take a single parameter. In the case of the first function, said parameter will always be a response object. In the case of the second parameter, this is an error object which may be an object of some kind. | ||
### PublicConnection example | ||
``` | ||
var vt = require("node-virustotal"); | ||
var con = vt.MakePublicConnection(); | ||
con.setKey("e2513a75f92a4169e8a47b4ab1df757f83ae45008b4a8a49903450c8402add4d"); | ||
console.log(con.getKey()); | ||
con.setDelay(15000); | ||
console.log(con.getDelay()); | ||
con.checkIPv4("90.156.201.27",function(data){ | ||
console.dir(data); | ||
}, function(err){ | ||
console.error(err); | ||
}); | ||
``` |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
6667
61