descript-org / descript3

MIT License
8 stars 6 forks source link

Предлагаю немного прояснить доку о кешировании #31

Open toiletpatrol opened 3 years ago

toiletpatrol commented 3 years ago

В доке о кешировании docs/cache.md есть пример:

Задаем блоку кэш:

const cache = new de.Cache();

const block = de.block( {
    options: {
        cache: cache,
    }
} );

Он немного сбивает с толку, потому что key - по сути обязательный параметр, без него кеш не заработает.

Думаю, можно объеденить последние 2 примера. А в описании добавить, что без key не заработает.

const cache = new de.Cache();

const block = de.block( {
    options: {
        //  Кэшируем по имени метода и параметру id
        key: ( { params } ) => `my_method:id=${ params.id }`,
        //  Храним 1 час.
        maxage: 60 * 60 * 1000,
        //  Задаем в каком кэше все храним.
        cache: cache,
    }
} );