Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

hops-mixin

Package Overview
Dependencies
Maintainers
5
Versions
147
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

hops-mixin

Building blocks to build cusom hops mixins

  • 15.2.1
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
5
Created
Source

hops-mixin

npm

Please see the main Hops Readme for general information and a Getting Started Guide.

Contains the building blocks needed to build your own hops mixins. Mixins allow you to alter and extend Hops' functionality.

Tap into them using your own mixins and reconfigure Webpack, register additional Express middlewares and Yargs commands or fetch data to bootstrap your React application.

Please be aware that the mixin hooks are not part of the SemVer API contract. This means that hook methods and signatures can change even in minor releases. Therefore it's up to you to make sure that all hooks that you are using in your own mixins still adhere to the new implementation after an upgrade of a Hops packages.

Installation

npm install --save hops-mixin

If you don't already have an existing Hops project read this section on how to set up your first Hops project.

API

Mixin

Base class to extend from when building a mixin. Ensures the config is available in this.config.

const { Mixin } = require('hops-mixin');

class MyMixin extends Mixin {}
strategies

Strategies allow to define mixin hooks that are usable by other mixins. There are various types of strategies. callable will make the method available to other mixins. Methods with strategy pipe pass each implementation's output to the next, using the first argument as the initial value. All other arguments are being passed to all implementations as-is.

For a complete list of available strategies, have a look at the mixinable documentation.

Callable example

A mixin that exposes a method to retrieve the build config.

const {
  Mixin,
  strategies: { sync: callable },
} = require('hops-mixin');

class BuildConfigMixin extends Mixin {
  getBuildConfig() {
    return this.buildConfig;
  }
}

MyMixin.strategies = {
  getBuildConfig: callable,
};

Other mixins are now able to call the method.

const { Mixin } = require('hops-mixin');

class ConsumerMixin extends Mixin {
  myMethod() {
    const config = this.getBuildConfig();
  }
}

Keywords

FAQs

Package last updated on 20 Jun 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc