npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

web-search

v0.6.2

Published

A package to provide search URLs for websites from a search term.

Downloads

4

Readme

web-search

A package to provide search links for website from a search term.

Web Search on NPM

Install

# Using yarn
yarn add web-search

# Using npm
npm install web-search

Usage

Basically, you just need to provide the website to make the search and the search term.

import webSearch from "web-search";

webSearch("npmjs.com", "web-search");
// => "https://www.npmjs.com/search?q=web-search"

API

webSearch

The main function, get search URL in a website from a search term.

  • Allow compact/human-friendly URL
webSearch("google.com", "how to make a carrot cake");
// => "https://google.com/search?q=how%20to%20make%20a%20carrot%20cake"
  • Allow complete URL, just get the host name
webSearch("https://duckduckgo.com/?justGet=theHostName", "dogecoin");
// => "https://duckduckgo.com/?q=dogecoin"
  • Returns undefined with a unknown website
webSearch("ea6194cb-47e1-4165-9090-0fa80539e82a.com", "what is uuid?");
// => undefined
Parameters

| Parameter | Type | Description | Example | | ------------- | -------- | ------------------------------- | -------------- | | websiteURL | string | The website to make the search. | "npmjs.com" | | searchQuery | string | The search term. | "web-search" |


webSearchData

If you just want to make cool stuff with the data behind the webSearch, webSearchData returns it with the name and URLs of each website.

import webSearch, { webSearchData } from "web-search";

webSearchData();
// => {
//     websites: [
//         {
//             "name": "Example Domain",
//             "url_prefix": "https://example.com/search?q="
//         },
//         ...
//     ]
// }
Interfaces
  • WebSearchData

The data from data.json, storing the websites.

websites is an array with these properties:

| Property | Type | Description | Example | | ------------ | -------- | ----------------------------------------- | ------------------------------ | | name | string | Website name. | "DuckDuckGo" | | url_prefix | string | The search url before the search term. | "https://duckduckgo.com/?q=" | | url_suffix | string | The (optional) url after the search term. | "&iax=images&ia=images" |

It is recommended to include additional query variables in url_suffix.

Contributing

At the end of the day, web-search is greater with more and more websites. So don't hesitate to contribute!

Check here the instructions.