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

@wral/sdk-search

v0.0.1

Published

A Software Development Kit for working with our federated search engine

Downloads

2

Readme

sdk-search

The sdk-search is a JavaScript SDK (Software Development Kit) designed to interact with the search API.

Installation

You can install the `sdk-search

npm install @wral/sdk-search

Usage

To use the sdk-search, you first need to import it into your JavaScript or TypeScript project:

import { createClient } from '@wral/sdk-search';

Then, you can create a client instance with your configuration:

const config = {
  baseUrl: 'YOUR_BASE_URL', // Base URL of your API
  apiKey: 'YOUR_API_KEY', // Optional API key
};

const client = createClient(config);

After creating the client instance, you can use its methods to interact with the API.

API

createClient(config)

Creates a new client instance with the provided configuration.

  • config: An object containing API configuration parameters:
    • baseUrl: The base URL of the API.

Returns a client instance with methods for interacting with the API.

Methods

  • api: (path, options = {}): fetch wrapper for the API.