wistroni40-retry v0.0.4

wistroni40-retry

Install

npm i wistroni40-retry --save

Table of Contents

• Quickstart
• Feature
• API
  • ProducerAdapter
  • RetryOption
  • Producer
  • RetryTemplate
  • Retry

Quickstart

Full Example

/**
 * Kafka Producer轉接器
 */
class MyProducer extends ProducerAdapter<HighLevelProducer> {
  /**
   * @param kafkaProducer Kafka Producer
   * @param options       重拋配置
   */
  constructor(
    protected kafkaProducer: HighLevelProducer,
    protected options?: RetryOption
  ) {
    super(kafkaProducer, options);
  }

  /**
   * 發送數據
   *
   * @method public
   * @param payload  要拋送的數據 
   * @param callback 拋送後的回乎函數
   */
  public send(
    payload: ProduceRequest[],
    callback: (error: any, result: any) => void
  ): void {
    this.kafkaProducer.send(payload, (err, res) => callback(err, res));
  }
}

const myProducer = new MyProducer(PRODUCER);
const payload = { data: 100 };
myProducer.publish(payload);

Feature

• 提供拋送者介面，實作介面中的send方法，並在送出資料時使用publish方法，即可在拋送資料失敗時，重新拋送
• 超出失敗上限後將資料備份至特定路徑

API

ProducerAdapter

Abstract Class，拋送者轉接器

constructor

ProducerAdapter的建構值

Methods

publish

資料上拋方法，拋送失敗會自動嘗試重新拋送

send

Abstract Method，須實作此方法，資料上拋，但失敗不會自動重新拋送

RetryOptions

Interface，重拋配置項目

Properties

Producer

Interface，拋送者介面

Methods

send

須實作此方法，資料上拋

RetryTemplate

Abstract Class，重拋機制範本

constructor

RetryTemplate的建構值

Methods

updateOptions

更新重拋配置

retry

Abstract Method，須實作此方法，嘗試重新拋送資料

Retry

Class extends from RetryTemplate，重拋機制

Methods

retry

嘗試重新拋送資料