sprut-gear-chain v0.6.1-beta.2

> npm i sprut-gear-chain

Sprut-gear-chain

Инструмент тестируется и будет дописываться или переписываться.

До версии 1.0.0 интерфейсы некоторых методов могут отличаться от релиза к релизу.

Прошу понять и простить.

Инструмент управления состоянием данных. Упрощает слежение за изменениями данных и создание реакции на изменения. По результату и использованию похоже на mobX. Конфигурация происходит на уровне прототипа с минимальными действиями во время работы с данными. По крайней мере такой была попытка. Писалось в целях обучения, эксперимента, для нужд собственных разработок и из принципа. Типизацию пока не доробатывал.

Оглавление

• Быстрое использование
• В функциональном стиле и пример с использованием ожидания
• Аналог configure
• Пример использования с конфигом
• Отсоединение хранилища от зависимостей
• Таймаут функция
• Использование asyncWatcher
• Модификатор поведения hush
• Инструмент извлечения чистых данных spread

Быстрое использование:

• К оглавлению

const { configure, callback } = require('sprut-gear-chain');

class Store {
    constructor() {
        configure(this);
    }

    reactiveProp = 1;
}

const store = new Store();

callback(() => console.log(store.reactiveProp), () => store.reactiveProp);
store.reactiveProp++; // В логе выведет 2

configure(object, config?) модифицирует прототип объекта при создании первого экземпляра. В последующих созданиях экземпляров выполняет минимум действий по донастройке объекта с уже модифицированным прототипом. Метод также предполагает использование конфига вторым аргументом и также может подобрать конфиг из свойства объекта .storeConfig. При использовании без конфига модифицирует все свойства, которые найдёт в объекте и прототипе. Геттеры и сеттеры преобразовывает в computed свойства, а значения в reactive свойства.

В функциональном стиле и пример с использованием ожидания:

• К оглавлению

const { value, computed, waiting, callback, someIsWaiting } = require('sprut-gear-chain');

const [ getValue, setValue ] = value('value');
const [ getComputed, setComputed ] = computed(() => {
    const result = getValue() + ' is reactive';

    return waiting((put) => {
        const timeout = setTimeout(() => put(result), 1000);

        return () => clearTimeout(timeout);
    });
}, () => { /* setter */ });

const [ exec, dissociate ] = callback(() => {
    if (!someIsWaiting(getComputed())) {
        console.log(getComputed());
    } else {
        console.log('waiting');
    }
}, () => getComputed());

setTimeout(() => {
    setValue('new value');
}, 5000);

// Лог выведет
// value is reactive
// waiting
// new value is reactive

put удастся использовать до следующего изменения, после чего он отключится. Также будет вызвана функция, если таковая возвращалась из функции, вброшенной в waiting(). Можно использовать для отключения ожидающих реакций. put до момента отключения можно использовать множество раз. При изменении будет создан новый и старые и новые не будут пересекаться и перебивать друг друга.

Также waiting() можно использовать как инициализирующее значение для reactive полей класса(обычных значений) и в фукнции value() при создании значения.

Аналог configure:

• К оглавлению

Вместо использования конфига и метода configure() возможно использовать похожий вариант конфигурации без автоматической кофигурации. Для корректной работы нужно вызвать init(this) в конструкторе. Он также вызывается внутри configure() из предыдущих примеров.

const { storable, init } = require('sprut-gear-chain');

class Store {
    constructor() {
        init(this);
    }
}

storable(Store);

Store.configure({
    reactive: {
        prop: {
            default: 'default value',
            immediate: true
        },
        prop_2: {
            default: () => new EventTarget(),
            isFactory: true
        }
    },
    methods: {
        methodName: {
            method() {
                console.log(this.prop);
                this.prop_2.dispathEvent(new Event('event'));
            },
            autoExec: true,
            initedStart: true
        }
    }
});

Пример использования с конфигом:

• К оглавлению

const { configure } = require('sprut-gear-chain');

const config = {
    reactives: ['reactiveProp'],
    reactive: {
        immediateProp: {
            immediate: true
        }
    },
    methods: {
        autorunMethod: {
            autoExec: true,
            dependencies() {
                this.immediateProp;
                this.reactiveProp;
            }
        }
    }
};

class Store {
    storeConfig = config;

    constructor() {
        configure(this);
    }

    reactiveProp = 1;

    immediateProp = 'prop';

    autorunMethod() {
        console.log('immediateProp = ', this.immediateProp, ', reactiveProp =', this.reactiveProp);
    }
}

const store = new Store();

store.reactiveProp++;
store.immediateProp = 'value';
// Лог:
// immediateProp = value, reactiveProp = 1
// immediateProp = value, reactiveProp = 2

Такой лог будет выведен из-за того, что одно из свойств является immediate: true. При изменении данных все изменения и методы отрабатывают один раз через короткий промежуток времени, в следующем фрейме или по таймауту. Таким образом состояние хранилищ остаётся тем же, и данные будут браться из кеша или расчитываться при запросе данных из геттеров или реактивных свойств.

Но если использовать immediate поля или применять модификаторы поведения immediate(value) или deferred(value) поведение будет отличаться.

Например:

store.reactiveProp++;
store.immediateProp = deferred('value')
// Лог:
// immediateProp = value, reactiveProp = 2

deferred - модификатор заставляет дождаться общего выполнения задач по изменению данных вне зависимости от настроек.

immediate - модификатор заставялет сразу выполнить применение значения вне зависимости от настроек.

По умолчанию значения применяются не сразу. Но можно заставить все поля изменяться сразу прописав такую настройку:

class Store {
    static __updateImmediately = true;

Либо:

class Store {
    __updateImmediately = true;

Либо:

class Store {
    constructor() {
        this.__updateImmediately = true;
    }

Отсоединение хранилища от зависимостей:

• К оглавлению

store.dissociate(propName);

Такой вариант уничтожит зависимости для конкретного поля.

Чтобы уничтожить зависимости на всех полях следует использовать тот же метод без аргументов:

store.dissociate();

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

Таймаут функция:

• К оглавлению

Также можно задать таймаут-функцию для отложенного обновления. По умолчанию это setTimeout с нулевым интервалом. Но можно закинуть и requestAnimationFrame, если вы в браузере либо в electron, например:

const { useTimeoutFunction } = require('sprut-gear-chain');

useTimeoutFunction(requestAnimationFrame);

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

• К оглавлению

asyncWatcher отслеживает зависимости в асинхронной функции. asyncWatcher должен быть вызван внутри отслеживаемого метода или фукнции в callback. Оборачивает функцию.

Например:

callback(() => {
    setTimeout(asyncWatcher(() => console.log(store.reactiveProp)), 50);
}, () => store.reactiveProp);

Вторым аргументом в callback применяется функция для исследования зависимостей. В дальнейшем зависимости будут исследовать при выполнении автоматически запускаемых методов. Если не указана функция для исследования зависимостей, метод может быть запущен с самого начала автоматически. Третьим аргументом может быть прокси-функция, которая будет вызвана после изменений зависимостей. Таким образом можно наблюдать за зависимостями какого-то метода и запускать механизм использующим данный метод. Например функции или методы рендера компонентов. А через прокси запускать перерендер этих компонентов. Например:

const [ getValue, setValue ] = value(0);
const view = (...props) => getValue().toString() + ', ' + props.join(', ') + '.';
const someProps = [ 'prop_1', 'prop_2', 'prop_3' ];
const render = () => {
    console.log(observerVeiw(...someProps));
};
const [ observerVeiw, dissociate ] = callback(view, undefined, render, { initedStart: true });

setValue(1);

В классах, если метод переопределяется как наблюдаель, метод автоматически будет реагировать на изменения своих зависимостей. В случае callback() он сам возвращает обёрнутую функцию и использовать для дальнейшего наблюдения зависимостей следует именно её, как в примере выше, так как зависимости в разных условиях могут изменяться.

В сущности callback-фукнция является методом скрытого стора.

Модификатор поведения hush:

• К оглавлению

Используется, чтобы положить значение в reactive поле без вызова реакций. Следует класть любое значение, кроме модифицированных одним из модификаторов поведения.

const { hush } = require('sprut-gear-chain');

store.reactiveProp = hush('value');

Инструмент извлечения чистых данных spread:

• К оглавлению

spread используется для извлечения данных из реактивных свойств и геттеров. Возвращает чистый объект. Игнорирует методы. Обычный спред не сработает, так как значения лежат на уровне прототипа.

const { spread } = require('sprut-gear-chain');

console.log(spread(store));
// Выведет:
// { ... } - Чистый объект.

Описаны не все особенности. Некоторое из неописанного, возможно, будет выпилено.