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

floss-js

v1.0.0

Published

create event handler functions to modify user-defined variables and object properties.

Downloads

6

Readme

FLOSS

FLOSS.js - суперлегковесная библиотека (< 1kb) позволяющая создавать обработчики события изменения переменных и свойств объекта.

Выглядит обработчик следующим образом:

FLOSS({
  name: 'name', /* Имя переменной. Если переменной не существует, то она будет создана. */
  value: 'value' /* Изначальное значение переменной. */
  action: function(value){ ... } /* Функция - обработчик события изменения переменной, которая вызывается каждый раз при изменении и котоаря принимает новое значение. Впервые обработчик срабатывает при создания FLOSS обработчика. */,
  defer: true /* Специальный необязательный параметр, откладывающий выполнение обработчика action. Таким образом обработчик сработает впервые при первом изменении переменной, а не по факту добавления обработчика. */
  bind: false /* Контекст переменной. Если контекст не указан, то создается глобальная переменная в window. Однако для  локального отслеживания изменения свойства объекта, сюда следует передавать сам объект. */
});

Рассмотрим два варианта использования FLOSS методов слежения за переменной.

Первый (простой) вариант

Предположим есть переменная state, в которую с сервера приходит текущее состояние. Значение переменной state отображается в браузере пользователя. Каждый раз, когда состояние обновляется нам необходимо изменять DOM дерево, что бы пользователь мог видеть текущее состояние.

    <h1>Тeкущее состояние: <span class="js-state"></span></h1>
<script>
    FLOSS({
        name: 'state', /* создаем глобальную переменную */
        value: 'waiting', /* какое-то default значение, которое будет видеть пользователь, пока ожидает ответа от сервера */
        action: (value) => {
            /* обработчик события изменения. При использовании стрелочной функции, как в этом примепе, следует передавать в функцию новое значение явно. Для обычных функция к новому value можно обращаться через this. */
            document.querySelector('.js-state').innerHTML = value;
        }
    });
</script>

Вот и все. Теперь каждый раз при изменении переменной state (например state = 'Ошибка на сервере') тут же сработает обработчик.

Второй (более продвинутый) вариант

На практике использовать глобальные переменные не всегда удобно. Зачастую используются более сложные структуры и появляется необходимость локально отслеживать изменения свойств того или иного объекта.

Рассмотрим похожую ситуацию. Необходимо дать пользователю возможность контролировать какое-либо состояние. Только теперь у нас есть объект server, содержащий множество разных свойств и методов. Одно из свойств служит хранилищем уведомлений для пользователя.

    var server = {
        state: {
            200: 'OK',
            201: 'Created',
            203: 'Non-Authoritative Information',
            526: 'Invalid SSL Certificate'
        },
        logs: '...',
        status: '200',
        notification: function(){
            return `${this.state[this.status]}, status: ${this.status}`
        }
    }

То есть существует свойство notification формирующее уведомление для пользователя.

html код все тот же:

    <h1>Тeкущее состояние: <span class="js-state"></span></h1>

FLOSS обработчик будет выглядеть следующим образом:

    FLOSS({
        name: 'status', /* свойство, котрое необходимо отслеживать */
        /* value в данном примере отсутствует, так как это значение вычисляется самим объектом */
        action: function(){
            document.querySelector('.js-state').innerHTML = server.notification();
        },
        defer: true, /* отключаем срабатывание action при создании обработчика. Action будет срабатывать только по факту изменения свойства */
        bind: server /* объект, свойсто которое необходимо отслеживать */
    });

Таким образом: при изменении свойства status объекта server будет вызываться метод notification и результат его выполнения отображаться пользователю.

В файле index.html есть еще пример, с которым можно ознакомиться: дсписко имен, строка поиска и динамическое отображение имен удовлетворяющих условиям поиска.