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

@glacierjs/window

v0.1.7

Published

为运行在主线程的代码提供 ServiceWorker 的注册与卸载,以及支持插件化编程。

Downloads

46

Readme

@glacierjs/window

为运行在主线程的代码提供 ServiceWorker 的注册与卸载,以及支持插件化编程。

快速使用

import { GlacierWindow } from '@glacierjs/window';

// generate glacier with ./service-worker.js which in your host.
const glacier = new GlacierWindow('./service-worker.js');

// register service worker.
glacier.register();

插件的编写与使用

编写插件:

import { WindowPlugin } from '@glacierjs/window';
import type { UseContext } from '@glacierjs/window';

export class MyPluginWindow implements WindowPlugin {
    constructor() {...}
    public async onUse(context: UseContext) {...}
    public async beforeRegister() {...}
}

使用:

import { GlacierWindow } from '@glacierjs/window';
import { MyPluginWindow } from './my-plugin';

// generate glacier with ./service-worker.js which in your host.
const glacier = new GlacierWindow('./service-worker.js');

glacier.use(new MyPluginWindow());

// register service worker.
glacier.register();

Lifecycle

onUse: (context: UseContext) => void

  • context <UseContext> 当前上下文,可以获取到 workbox 实例和当前 glacier 实例

当插件被使用的时候,该钩子会被触发:

glacierWindow.use(new MyPlugin());

如果你的插件在后续的运行中需要用到 workbox 实例或者 glacier 实例,
可以在此阶段把它们留在当前插件作用域中:

public onUse(context: UseContext) {
    const { glacier, workbox } = context;
    this.glacier = glacier;
    this.workbox = workbox;
}

beforeRegister: (context: Object, next?: NextFn) => Promise<void>

  • context 一个空对象,插件们可以以此作为通信手段。
  • next <HookFn> 返回一个Promise,用以监听后面的插件的完成或者失败。

当即将要注册主线程时,该钩子会被触发。
在此阶段你可以进行一些异步操作,例如我们通过远程配置来决定是否要卸载 ServiceWorker:

public async beforeRegister(): Promise<void> {
    const config = await fetchRemoteConfig();

    // uninstall service worker while switch off
    if (config.switch === false) {
        // tell service worker thread to do some cleans job , and then uninstall it.
        this.glacier.unregister();

        // cut off behind plugins calling.
        throw ner Error('switch off service worker');
    }
}