Package Exports

google-sr
google-sr/dist/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (google-sr) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

google-sr 🔍

Simple & Fast Package for scraping Google search results without the need for an API key. 🚀

View documentation here

Features ✨

Simple & Fast ⚡️ *
Well tested 🔄
Well documented 📚
TypeScript compatible 🧑‍💻
No API key is needed 🔑
Wide variety of search result types supported 🌴

Install 📦

To get started, you can install google-sr using your preferred package manager:

# npm

npm install google-sr

# pnpm 

pnpm add google-sr

# yarn

yarn add google-sr

Usage

Simple example

You can easily perform a single-page search like this:

import { search } from 'google-sr';

search({ query: 'nodejs' }).then(console.log);

// or if using await/async
const searchResults = await search({ query: 'nodejs' });
console.log(searchResults);

Read about the returned types here

More detailed examples & usage can be found here

Additional examples can be found in tests

Disclaimer

This is not sponsored, supported, or affiliated with Google Inc.

`The module scrapes the google search result page instead of using the API as suggested by google. Author is NOT responsible for any issue (ip block from google, etc...) that occurs due to misuse.

Tests

Tests are written using mocha and can be run by using the test script.

Weekly tests a executed using a github action to ensure compatibility

Project uses pnpm as its package manager

pnpm run test

Support & Bug Reporting 🛠️🐞

Make sure you are on the latest version before creating bug reports

Support and bug reporting both can be done on github issues

License

This repository and the code inside it is licensed under the Apache-2.0 License. Read LICENSE for more information.