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

@alfalab/client-event-bus

v2.0.2

Published

@alfalab/client-event-bus ===

Downloads

116

Readme

@alfalab/client-event-bus

Библиотека позволяет обмениваться данными в приложениях с модульной архитектурой (module federation), используя событийную модель браузера. Это особенно актуально для приложений на базе Webpack Module Federation, обеспечивая взаимодействие без создания жестких зависимостей.

По сути представляет собой EventEmitter с добавлением методов для получения последнего отправленного события уже после того, как это событие произошло.

Для того чтобы добавить типизацию событий на проекте, не трогая основной пакет, можно сделать следующее:

constants/event-bus.ts - заводим ключ, по которому создается шина данных

// constants/event-bus.ts
export const BUS_KEY = 'my-first-bus';

types/event-bus.ts - определяем типы событий

// types/event-bus.ts
type EventType = 'busValueFirst' | 'busValueSecond'
type EventPayload = string | null

export type EventTypes = Record<EventType, EventPayload>;

types/event-types.d.ts - добавляем файл для типизации функций getEventBus и createBus

// types/event-types.d.ts
import type { AbstractAppEventBus } from '@alfalab/client-event-bus';

import { BUS_KEY } from '~/constants/event-bus';
import type { EventTypes } from '~types/event-bus'

export declare type EventBus = AbstractAppEventBus<EventTypes>;

declare module '@alfalab/client-event-bus' {
    export declare function getEventBus(busKey: typeof BUS_KEY): EventBus;
}

declare module '@alfalab/client-event-bus' {
    export declare function createBus(
        key: typeof BUS_KEY,
        params?: EventBusParams,
    ): EventBus;
}

Рекомендации использования

Для именования событий предлагается следующие договоренности:

  • Имя события начинается с названия вашего проекта, исключая префикс вашей системы/направления (corp-, ufr- и так далее) и суффикс -ui. То есть если ваш проект называется ufr-cards-ui событие должно начинаться с cards_, corp-sales-ui это соответственно sales_.
  • Название события пишется в camelCase.

Возвращаемое значение

Возвращает EventBus, со следующими методами:

  • addEventListener(eventName: string, eventHandler: (event: CustomEvent) => void, options?: AddEventListenerOptions) - стандартная функция добавления подписки на событие
  • removeEventListener(eventName: string, eventHandler: (event: CustomEvent) => void, options?: EventListenerOptions) - стандартная функция удаления подписки на событие
  • getLastEventDetail(eventName: string) - Функция, которая возвращает последнее событие заданного типа. Если событие еще не происходило - возвращает undefined
  • addEventListenerAndGetLast(eventName: string, eventHandler: (event: CustomEvent) => void, options?: AddEventListenerOptions) - объединяет в себе addEventListener и getLastEvent. Подписывает на событие и возвращает последнее событие этого типа

Использование в react

Если вам нужно использовать значение из event-bus в react коде - вы можете использовать хук useEventBusValue:

import { useEventBusValue } from '@alfalab/client-event-bus';

const MyComponent = () => {
    const currentOrganizationId = useEventBusValue('shared_currentOrganizationId');

    return (
        <div>
            ID текущей организации: {currentOrganizationId}
        </div>
    )
}

Хук всегда будет возвращать последнее значение из eventBus. При изменениях значения будет происходить ререндер.