wix-duplexer-protocol

Building blocks of Duplexer protocol.

Install

npm install wix-duplexer-protocol

Usage

import {
  RestoreStrategyBuilderFactory,
  PollOverrideRestoreStrategyBuilder,
  PollPayloadBuilder
} from 'wix-duplexer-protocol';

const messageIdRestoreStrategy = RestoreStrategyBuilderFactory
  .messageId()
  .withId('123')
  .build();

const allRestoreStrategy = RestoreStrategyBuilderFactory
  .all()
  .build();

const channelOverride = new PollOverrideRestoreStrategyBuilder
  .withNs('some-ns')
  .withChannelName('some-channel-name')
  .withRestoreStrategy(messageIdRestoreStrategy)
  .build();

const anotherOverride = new PollOverrideRestoreStrategyBuilder
  .withNs('different-ns')
  .withChannelName('some-channel-name')
  .withRestoreStrategy(messageIdRestoreStrategy)
  .build();

const pollPayload = new PollPayloadBuilder
  .withOverrideRestoreStrategy(channelOverride)
  .withOverrideRestoreStrategy(anotherOverride)
  .build();

API

PollPayloadBuilder

PollPayloadBuilder.withOverrideRestoreStrategy(): PollPayloadBuilder

Add an override restore strategy.

PollPayloadBuilder.build(): PollPayload

Get a new instance of poll payload.

PollOverrideRestoreStrategyBuilder

PollOverrideRestoreStrategyBuilder.withNs(ns: string): PollOverrideRestoreStrategyBuilder

Add a namespace.

PollOverrideRestoreStrategyBuilder.withChannelName(channel: string): PollOverrideRestoreStrategyBuilder

Add a channel name.

PollOverrideRestoreStrategyBuilder.withRestoreStrategy(restoreStrategy: RestoreStrategy): PollOverrideRestoreStrategyBuilder

Add a restore strategy to override the default one.

PollOverrideRestoreStrategyBuilder.build(ns: string): PollOverrideRestoreStrategy

Build a new override restore strategy.

RestoreStrategyBuilderFactory

RestoreStrategyBuilderFactory.all(): AllRestoreStrategyBuilder

Builder for "all" restore strategy.

RestoreStrategyBuilderFactory.messageId(): MessageIdRestoreStrategyBuilder

Builder for "message id" restore strategy.

AllRestoreStrategyBuilder

AllRestoreStrategyBuilder.build(): RestoreStrategy

Get a new instance of "all" restore strategy.

MessageIdRestoreStrategyBuilder

MessageIdRestoreStrategyBuilder.withId(id: string)

Add an id.

MessageIdRestoreStrategyBuilder.build(): RestoreStrategy

Get a new instance of "message id" restore strategy.