Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pipebits/general-search-engine
This module will allow you to search for modules in npm, images in google, repos in github... without any API KEY
https://github.com/pipebits/general-search-engine
api github google image javascript node npm search wikipedia
Last synced: 2 months ago
JSON representation
This module will allow you to search for modules in npm, images in google, repos in github... without any API KEY
- Host: GitHub
- URL: https://github.com/pipebits/general-search-engine
- Owner: pipebits
- License: mit
- Created: 2021-05-02T20:25:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-07-18T23:54:32.000Z (over 3 years ago)
- Last Synced: 2024-09-29T00:21:40.894Z (3 months ago)
- Topics: api, github, google, image, javascript, node, npm, search, wikipedia
- Language: JavaScript
- Homepage:
- Size: 21.5 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# GENERAL SEARCH ENGINE
This module will allow you to search for modules in npm, images in google, repos in github... without any API KEY
# Installation
To do the installation correctly you need to have [node](https://nodejs.org/en/) installed
```
npm:
npm i general-search-engine
```
## Usage
```js
const gse = require("general-search-engine")
async function main(){
let petition = await new gse.search()
.setType("image")
.setQuery("pink elephant").run()
console.log(petition)
}
main()
/*
This will return an array like this:
[{
image: ,
title: 'Pink Elephant | pint...',
from: 'pinterest.com'
},
{
image: ,
title: 'Buy Pink Elephant...',
from: 'amazon.com'
}...]
*/
```
## Reference
Functions references, for examples [Here](https://github.com/pipebits/general-search-engine/tree/main/tests-examples)
#### 1. General
|Function|Result|Comments|
|--|--|--|
|gse.version|:String|Package version|
|gse.homepage|:String|Package homepage|
|gse.bugReport|:String|Package bugReport page|
|gse.contact|{...}|Contact information|
||Email|Contact email
||Discord|Discord tag
||Github|Github profile
#### 2. Search
|Function|Result|Comments|
|--|--|--|
|new gse.search() |{...}|Contact information|
||.setType(type)|Set the search type|
||.setQuery(query)|Set the query to search|
||.setOptions({options})|Set search options|
||.run()|Make the search with the actual parameters (This funcion is asynchronous)|
### Types and Return arrays:
#### Npm:
Find and get npm packages preview.
|Return|Object params|Return|
|--|--|--|
|[{...} ...]|title|:String|
||description|:String|
||author|:String|
||version|:String|
||maintenance|:String|
||quality|:String|
||popularity|:String|
#### Image:
Find and get image from Google Images.
|Return|Object params|Return|
|--|--|--|
|[{...} ...]|image|:String|
||title|:String|
||from|:String|
#### Github:
Find and get github repositories preview.
|Return|Object params|Return|
|--|--|--|
|[{...} ...]|title|:String|
||description|:String|
||topics|[:String ...]|
||stars|:String|
#### Wikipedia:
Find and get wikipedia articles preview.
|Return|Object params|Return|
|--|--|--|
|[{...} ...]|title|:String|
||description|:String|
||link|[:String ...]|
#### Search:
Find and get pages preview from Google Search.
|Return|Object params|Return|
|--|--|--|
|[{...} ...]|title|:String|
||description|:String|
||link|[:String ...]|