@24hr/rawb-content-cache 中文文档教程

Question

RAWB Content Cache

该模块保留来自提取的缓存内容并订阅 RAWB 内容服务上的事件，以便它可以重新提取 当在源头更新正确的内容时。

Example

const ContentClient = require('@24hr/rawb-content-cache');

const config = require('../config');
const logger = require('../logger');

const client = ContentClient({

    // This can be an internal url as in docker-compose or an external url. 
    // It can also contain a port. The content service will by defautl expose internally the default redis port.
    redisUrl: 'redis://url.to.your.service', 

    // The role of this server, since the content service can be run as both draft and live, we need to know which is targeted
    role: config.ROLE,

    // [optional] A logger, like winston. If none is provided, it will fallback to console.log and console.error
    logger,

    // [optional] An api token, that will be used as Bearer, if needed
    apiToken: config.API_TOKEN,

});

// The first parameter is the siteId, which is needed as part of the request in the content service since it might provide data for several sites.
// The second parameter is the resource key.
// The third parameter is the url to fetch the resource. This is typically just the url of the content service with the key, 
// but in some cases it might go trough something else. 
const response = await client.fetch('foo', '/mycoolresource', 'http://your.content.service.com/foo');

console.log(response);

在上面的示例中，在第一次获取数据时，内容缓存模块将开始侦听该资源的 redis 事件。 当它收到信号时，它将使用资源 url（第三个参数）重新获取资源。

fetch and subscribe

上面的示例显示了 fetch 函数。 客户端还将公开一个名为 subcribe 的函数，它更简单一点：

client.subscribe('foo', '/mycoolresource', (data) => {
    console.log('documentType', data.documentType);
    console.log('hash', data.hash);
    console.log('resource', data.resource);
    console.log('externalId', data.externalId);
});

subscribe 函数不会为您获取任何内容，但会注册回调以便您可以获取任何内容你需要。 它也不会为您提供内容，只是对它的引用。

History

• 0.8.3 [2019-09-08] : Updated docs again
• 0.8.2 [2019-09-08] : Updated docs again
• 0.8.1 [2019-09-08] : Updated docs
• 0.8.0 [2019-09-08] : Refactored version with exposed fetch and subcribe after creating a client
• 0.7.0 [2019-09-07] : First functional working