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

@revmob/minimum-bid-validator

v0.1.3

Published

Revmob minimum bid validation utility

Downloads

3

Readme

Minimum Bid Validator

Motivation

This module contains simple rules for minimum bid retrieval and validation for different countries and OSs.

Installation

npm install --save @revmob/minimum-bid-validator

Usage

// CommonJS:
const minimumBidValidator = require('@revmob/minimum-bid-validation').default

// or with ES6 modules:
import minimumBidValidator from '@revmob/minimum-bid-validation'

Public Interface

Methods

minimumBidValidator.setDefaultMinimumBid(defaults: BidInfo) => Void
minimumBidValidator.setAllBidsByCountry(bids: CountryBids) => Void
minimumBidValidator.getMinimumBid(os: String, countryList: String[]) => Number | undefined
minimumBidValidator.validate(os: String, countryList: String[], currentBid: Number) => Void, throws: Error

Types

interface BidInfo {
  [os: String]: Number
}

interface CountryBids {
  [countryCode: String]: BidInfo
}

Rules

getMinimumBid
  • If the country list contains invalid countries, only the valid ones are considered.
  • If there are no valid countries in the country list, returns the default minimum bid.
  • If the country list contains all countries set in setAllBidsByCountry, returns the default minimum bid.
  • If the OS is missing for one or more of the countries, it will not be considered.
  • If the OS is missing for all countries, returns undefined.
validate
  • If the country list contains invalid countries, only the valid ones are considered.
  • If there are no valid countries in the country list, uses the default minimum bid to validate.
  • If the country list contains all countries set in setAllBidsByCountry, uses the default minimum bid to validate.
  • If the OS is missing for one or more of the countries, it will not be considered.
  • If the OS is missing for all countries, always throws.

Example

// First setup...
const defaultBids = {
  'android': 1,
  'ios': 2
}

// Setting the default bids
minimumBidValidator.setDefaultMinimumBid(defaultBids)

// Setting the bids for each country
const bids = {
  BR: { 'android': 1, 'ios': 1 }
  US: { 'android': 2, 'ios': 2 }
  IN: { 'android': 0.5, 'ios': 0.75 }
}

minimumBidValidator.setAllBidsByCountry(bids)

// Then using...

// Getting the minimum bid for android in ['BR', 'US']
minimumBidValidator.getMinimumBid('android', ['BR', 'US']) // returns 2

// Validate if a given bid is greater than or equal the minimum bid
minimumBidValidator.validate('android', ['BR', 'US'], 1) // throws Error