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

@stash-it/core

v0.2.0

Published

Core package for @stash-it ecosystem, containing interfaces and types for main class, adapters and plugins (and some other things).

Downloads

52

Readme

@stash-it/core

logo-stash-it-color-dark 2x

Set of interfaces and types for @stash-it, for main class, adapters and plugins (and some other things).

The main ones you'll be interested in are:

  • StashItAdapter - base class used to create your own adapters
  • StashItPlugin type to create your own plugins

See usage for examples.

Installation

npm

npx jsr add @stash-it/core

deno

deno add @stash-it/core

yarn

yarn dlx jsr add @stash-it/core

pnpm

pnpm dlx jsr add @stash-it/core

bun

bunx jsr add @stash-it/core

Usage

StashItAdapter

import { StashItAdapter } from '@stash-it/core';

// Your adapter class should extend from the base abstract class.
class MyAdapter extends StashItAdapter {
  // Your implementation here.
}

The base class contains two methods, that you should implement if your adapter requires establishing a connection and/or disconnecting from a storage.

For instance:

import { StashItAdapter } from '@stash-it/core';

// Your adapter class should extend from the base abstract class.
class MyAdapter extends StashItAdapter {
  override async connect(): Promise<void> {
    // Depending on the storage, it can look different.
    // For example:
    this.#database.connect();
  }

  override async disconnect(): Promise<void> {
    this.#database.connect();
  }
}

StashItPlugin

import { type StashItPlugin } from '@stash-it/core';

// Your plugin can be a function that returns StashItPlugin:
const myPlugin = (someArgsIfNeedBe): StashItPlugin => {
  // Your implementation here.
};

// It can also be an object, depends on what your plugin needs:
const myPlugin2: StashItPlugin = {
  // Your implementation here.
};

License

MIT

Contribution

Feel free to open an issue or a pull request.