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

@hoast/base-source

v3.1.1

Published

Base package for source packages.

Downloads

10

Readme

@hoast/base-source

Provides basic functionality for source package like an initialization function, sequentially running of certain code, and a finallize function called after the source is done iterating. Meant for developers to be used as a base for a hoast source package.

Install

npm install @hoast/base-source

Usage

Extends BasePackage.

Constructor

  • constructor Create package instance.
    • @param {Object} ...Options Options objects which can contain the following keys.
      • {Number} logLevel = 2 Log level given to the logger.

Variables

  • {Boolean} done Is set to true if all items are returned.
  • {Boolean} exhausted Set exhausted to true if the source has ran out of items to return.

Functions

  • async next Will be called by hoast itself to retrieve the next item.
    • @returns {Any} Retrieved data.

Abstract functions

The following functions can be implemented by the derived class and will automatically called if present. All functions are optional and don't have to be asynchronous.

  • async initialize Called only once before sequential and concurrent.
  • async sequential Called sequentially for each iteration call. Meaning while this method is running it won't be called until the ongoing call is finished. Useful for processes that have to happen in order. Useful for iterating over the items in the filesystem.
    • @returns {Any} Item.
  • async concurrent Called concurrently for each iteration call after the sequential call. Meaning this will run after the sequential call and in contrast to the sequential function will be called before a previous call has finished. Useful for reading file contents from the filesystem.
    • @params {Any} Data returned by the sequential method.
    • @returns {Any} Item.
  • async final Called after the source has been exhausted and is finished.

Example

// Import base modules.
import BaseSource from '@hoast/base-source'

class NewSource extends BaseSource {
  constructor(options) {
    super({
      // Default options.
    }, options)
  }

  async initialize() {
    // Initialize.
  }

  async sequential() {
    // Sequential.
    this.exhausted = true
    return {}
  }

  async concurrent(data) {
    // Concurrent.
    return data
  }

  async final() {
    // Final.
  }
}

export default NewSource

See the @hoast/source-readfiles package for another example.