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

propr

v1.0.3

Published

A proper way to interface with prepr.io

Downloads

1

Readme

propr

A proper way to interface with the Prepr API. This package provides an easy-to-use interface for fetching data from Prepr and supports GraphQL queries.

Installation

To install the package, run:

pnpm install propr

Usage

To use propr, import the createPreprClient function from the package and call it with the options for your Prepr account:

import { createPreprClient } from "propr";

const client = createPreprClient({
  token: "your_token_here",
});

Once you have created the client, you can use it to fetch data from Prepr:

const articles = await client.fetch("/articles");

You can also chain various methods to the client to specify additional options:

const articles = await client.sort("publishedAt").limit(10).fetch("/articles");

The client also supports GraphQL queries:

const query = `query ($slug: String!) {
  article(slug: $slug) {
    id
    title
    publishedAt
  }
}`;

const variables = { slug: "your-article-slug" };

const article = await client
  .graphqlQuery(query)
  .graphqlVariables(variables)
  .fetch();

API

createPreprClient(options: PreprClientOptions) => PreprClient

Creates a new instance of the Prepr client.

Options

  • token (required): The access token for your Prepr account.
  • baseUrl: The base URL for the Prepr API (default: https://cdn.prepr.io).
  • timeout: The timeout for API requests, in milliseconds (default: 4000).
  • userId: The user ID for A/B testing.

PreprClient

The Prepr client class.

Methods

userId(userId: string | number): PreprClient

Sets the user ID for A/B testing.

timeout(milliseconds: number): PreprClient

Sets the timeout for API requests, in milliseconds.

sort(field: string): PreprClient

Sets the field to sort the results by.

limit(limit: number): PreprClient

Sets the maximum number of results to return.

skip(skip: number): PreprClient

Sets the number of results to skip.

path(path: string): PreprClient

Sets the path for the API request.

token(token: string): PreprClient

Sets the access token for the Prepr account.

graphqlQuery(graphqlQuery: string): PreprClient

Sets the GraphQL query for the API request.

graphqlVariables(graphqlVariables: object): PreprClient

Sets the variables for the GraphQL query.

fetch<T = any>(request?: RequestInfo, options?: FetchOptions<"json">): Promise<T>

Fetches data from the Prepr API.

Properties

query: URLSearchParams

The URL search parameters for the API request.