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

@yqg/assets-retry

v1.1.7

Published

English | [简体中文](./README-cn.md)

Downloads

119

Readme

English | 简体中文

Auto Assets Retry

styled with prettier Build Status

A tiny non-intrusive library to retry your assets (scripts, stylesheets, images) when they failed to load, only 3 KB gzipped, even works with dynamic import!

Demo GIF

Demo URL

Table of Contents

Installation

Install with npm

$ npm install assets-retry --save

Then, inject the library at the beginning of the page with proper webpack configurations. See example

Use inline script directly

If you don't want to spend your time fiddling around with webpack configurations, you can inline the minified file with a script tag, and place it at the beginning of the page.

Usage

All you have to provide is the domain parameter, which are the domains to retry when assets failed to load.

// information of assets
var assetsRetryStatistics = window.assetsRetry({
    // domain list, only resources in the domain list will be retried.
    domain: ['your.first.domain', 'your.second.domain/namespace'],
    // maximum retry count for each asset, default is 3
    maxRetryCount: 3,
    // onRetry hook is how you can customize retry logic with, default is x => x
    onRetry: function(currentUrl, originalUrl, statistics) {
        return currentUrl
    },
    // for a given resource (except background-images in css),
    // either onSuccess or onFail will be eventually called to
    // indicate whether the resource has been successfully loaded
    onSuccess: function(currentUrl) {
        console.log(currentUrl, assetsRetryStatistics[currentUrl])
    },
    onFail: function(currentUrl) {
        console.log(currentUrl, assetsRetryStatistics[currentUrl])
    }
})

When the initialization is finished, following content gains the power of retrying automatically.

  • [x] All <script> tag in html
  • [x] All <link rel="stylesheet"> tag in html (properly configured)
  • [x] All <img> tag in html
  • [x] All dynamic script element created with document.createElement, such as dynamic import.
  • [x] All background-image in css

Config

The assetsRetry function takes an AssetsRetryOptions, which is defined as follows:

interface AssetsRetryOptions {
    maxRetryCount: number
    onRetry: RetryFunction
    onSuccess: SuccessFunction
    onFail: FailFunction
    domain: Domain
}
type RetryFunction = (
    currentUrl: string,
    originalUrl: string,
    retryCollector: null | RetryStatistics
) => string | null
interface RetryStatistics {
    retryTimes: number
    succeeded: string[]
    failed: string[]
}
type SuccessFunction = (currentUrl: string) => void
type FailFunction = (currentUrl: string) => void
type Domain = string[] | { [x: string]: string }
  • domain: domain list, can be array or object type
    • array type: assets will be retried from each domain in sequence, until it's loaded successfully or exceed maximum retry times.
    • object type: { 'a.cdn': 'b.cdn', 'c.cdn': 'd.cdn' } means failed assets from a.cdn should be retried from b.cdn, failed assets from c.cdn should be retried from d.cdn
  • maxRetryCount: maximum retry count for each asset, default is 3
  • onRetry: hook function which was called before trying to load any assets
    • the function takes 3 parameters:
      • currentUrl: next url to try
      • originalUrl: last failed url
      • retryCollector: information collector for current asset, if the asset was from url() function defined in your stylesheets, it will be null. When it's not null, it's an object with following properties:
        • retryTimes: current retry times (starts from 1)
        • failed: failed assets list(may be duplicated when retrying from the same domain multiple times)
        • succeeded: succeeded assets list
    • the function must return a String or null:
      • when null was returned, current retry will be terminated.
      • when string was returned, current retry url will be the return value.
  • onSuccess: hook function which was called when asset has loaded
    • currentUrl: return the asset name which you can use to get statistics from information collector
  • onFail: hook function which was called when asset failed to load
    • currentUrl: return the asset name which you can use to get statistics from information collector

FAQ

  1. Q: Stylesheets or background images are not retried from backup domain, why?

    A: Due to security policies of browsers, access to cssRules is not allowed for cross origin stylesheets by default. To fix this:

    1. Add crossorigin="anonymous" attribute on link element for cross origin stylesheets.
    2. Make sure that Access-Control-Allow-Origin HTTP Header is correct.

Browser Support

| | | | | | | | | | :--------------------------------------------------------------------------: | :----------------------------------------------------------------------: | :----------------------------------------------------------------------------: | :---------------------------------------------------------------------------------: | :------------------------------------------------------------------------: | :--------------------------------------------------------------------------: | :-------------------------------------------------------: | :----------------------------------------------------------------------------: | | 47+ ✔ | 15+ ✔ | 32+ ✔ | 10+ ✔ | 34+ ✔ | 10+ ✔ | 10+ ✔ | 4.4+ ✔ |

NPM scripts

  • npm t: Run test suite
  • npm start: Run npm run build in watch mode
  • npm run test:watch: Run test suite in interactive watch mode
  • npm run test:prod: Run linting and generate coverage
  • npm run build: Generate bundles and typings, create docs
  • npm run lint: Lints code
  • npm run commit: Commit using conventional commit style (husky will tell you to use it if you haven't :wink:)

Acknowledgement

  1. The example projects are based on amazing RealWorld demo apps.
  2. Cross browser testing are based on the rather excellent BrowserStack UI testing technology.