0.2.0 • Published 7 years ago

startup-website-grabber v0.2.0

Weekly downloads
10
License
BSD-2-Clause
Repository
github
Last release
7 years ago

Startup Website Grabber

Travis CI

Provides for an easy way to grab URLs of startup companies.

  • Grabs startup website links.
  • Takes screenshot of main page.
  • Takes video of website scroll.
  • Gets performance metrics of website JS runtime.

Usage

constructor( callback )

callback takes the form of ( err, instance ) and is called when the initial loading of the module is done. Not using the callback results in a race condition when attempting to load and use providers.

grab( options, callback )

Starts grabbing links and taking screenshots of websites based on the options specified.

The options argument is optional, and defaults to the following:

{
	howMany: 100,
	provider: randomProvider,
	links: true,
	screenshots: false
}

availableProviders()

Returns a simple array of names of providers; Right now only 500 Startups is used.

stop()

If you'd like to stop the grab that is currently going on.

Examples

Example: Grab the first ~100 links from a random provider.

const StartupWebsiteGrabber = require( "startup-website-grabber" );

new StartupWebsiteGrabber( function( err, inst ){
	inst.on( "link", function( link ){
		console.log( link );
	} );

	inst.grab( function( err ){
		// done the grab.
	} );
} );

Example: Use an alternative limit on the maximum number of results returned from a specific provider.

const StartupWebsiteGrabber = require( "startup-website-grabber" );
new StartupWebsiteGrabber( function( err, inst ){
	inst.on( "link", function( link ){
		console.log( link );
	} );

	inst.grab( { howMany: 1000, provider: "500" }, function( err ){
		// done the grab.
	} );
} );

License

2-Clause BSD