google-this

The library can parse various specialized Google search results by using specific query patterns. When a search matches a known pattern, the corresponding field is populated in the response object.

Supported Patterns:

• Knowledge Graph: Search for entities (e.g., people, places, things).
• Google Translate: Use patterns like "translate [text] to [language]".
• Google Dictionary: Use patterns like "define [word]".
• Song Lyrics: Use patterns like "[song name] song lyrics".

The response from google.search() is a JSON object containing several key sections:

• results: An array of organic search result objects. Each object includes title, description, url, is_sponsored, and favicons (high_res and low_res).
• knowledge_panel: Data regarding the entity searched, including type, title, description, metadata (key-value pairs), ratings, and images.
• people_also_ask: An array of strings containing common questions related to the search query.
• featured_snippet: Information about the featured snippet if available.
• videos, top_stories, weather, time, location, dictionary, translation, unit_converter: Other specialized Google data sections (may be empty or null depending on the query).

You can install the googlethis module using npm, yarn, or directly from Git.

# NPM
npm install googlethis@latest

# Yarn
yarn add googlethis@latest

# Git 
npm install LuanRT:google-this

The options object passed to google.search() allows you to customize the search request:

• page: (number) The page number to retrieve (starting from 0).
• safe: (boolean) Enables or disables Safe Search.
• parse_ads: (boolean) If set to true, sponsored results (ads) will be parsed into the results.
• additional_params: (object) An object containing additional Google search parameters (e.g., hl for language).

The google-this library supports reverse image searching. When performing a reverse image search, the API returns an array of objects representing matching web pages. Each object contains the title, a description (which often includes image dimensions and snippets), and the source url.

[
   {
      "title":"Guess I'll Just Die | Meme Generator",
      "description":"401 × 401 · Oct 1, 2016 — Create your own images with the Guess I'll Just Die meme generator.",
      "url":"https://memegenerator.net/Guess-ILl-Just-Die"
   },
   {
      "title":"I Guess I Ll Just Die - Love Meme",
      "description":"401 × 401 · Apr 23, 2020 — 4 6k points 1 year ago. Upload your own image. Guess i ll die meme generator the fastest meme generator on the planet. A stock photo of a white ...",
      "url":"https://lovememepic.blogspot.com/2020/04/i-guess-i-ll-just-die.html"
   }
]

Use the google.image(query, options) method to search for images based on a text query. You can pass an options object to configure the search, such as setting safe: false to disable safe search filtering.

import google from 'googlethis';

// Image Search
const images = await google.image('The Wolf Among Us', { safe: false });
console.log(images);

Use the google.search(query, options) method to retrieve organic search results. The method is asynchronous and returns a response object containing search results, knowledge panels, and other Google-specific data.

import google from 'googlethis';

const options = {
  page: 0, 
  safe: false, // Safe Search
  parse_ads: false, // If set to true sponsored results will be parsed
  additional_params: {
    // add additional parameters here
    hl: 'en' 
  }
};
  
const response = await google.search('TWDG', options);
console.log(response);

To perform a reverse image search, use the google.search(imageBuffer, options) method. Pass a buffer of the image file and set the ris (Reverse Image Search) option to true in the options object. The results are accessible via the results property on the returned object.

import google from 'googlethis';
import fs from 'fs';

// Reverse Image Search
const my_awesome_image = fs.readFileSync('./wow.png');
const reverse = await google.search(my_awesome_image, { ris: true });

console.log(reverse.results);

When using definition queries, the dictionary field is returned containing phonetic information, audio links, definitions, and usage examples.

{
   "dictionary":{
      "word":"a·maz·ing",
      "phonetic":"/əˈmāziNG/",
      "audio":"https://ssl.gstatic.com/dictionary/static/sounds/20200429/amazing--_us_1.mp3",
      "definitions":[
         "causing great surprise or wonder; astonishing.",
         "startlingly impressive."
      ],
      "examples":[
         "\"an amazing number of people registered\"",
         "\"she makes the most amazing cakes\""
      ]
   }
}

When using translation queries, the translation field is returned containing the source and target language details and the translated text.

{
   "translation": {
      "source_language":"English - detected",
      "target_language":"German",
      "source_text":"this is a test",
      "target_text":"das ist ein Test"
   }
}