@radai/rad-service-client v0.0.18

Rad Service Client

Helper library for making service requests.

Quickstart

Install the package from npm:

npm install @radai/rad-service-client

Functions

• useQueue
• useRetry

useQueue

Custom hook to simplify managing, batching and flushing data from a queue in local storage.

This assumes that your data is JSON serializable (needed for localStorage).

Parameters:

• options: - Configuration options for the queue.
• options.flushCallback: - Callback function to be called when the queue is flushed.
• options.batchSize: - Number of items to batch before flushing.
• options.flushInterval: - Interval in milliseconds to automatically flush the queue.
• options.maxItems: - Maximum number of items allowed in the queue.
• options.localStorageKey: - Key to use for storing the queue in localStorage.

Examples:

const { add, addBatch, forceFlush, clear, getItems } = useQueue({ flushCallback: (items) => console.log('Flushed items:', items), batchSize: 3, flushInterval: 10000, maxItems: 500, localStorageKey: 'myQueue' });

// add items to the queue add({ id: 1, name: 'Item 1' }); // add multiple items to the queue addBatch({ id: 2, name: 'Item 2' }, { id: 3, name: 'Item 3' }); // force flush the queue immediately forceFlush(); // clear the queue without sending the items clear(); // peek at all items in the queue const items = getItems();

useRetry

Hook that wraps a function with retry logic.

The function will be retried up to retryMaxAttempts times with a backoff time of retryBackoffMs milliseconds between each attempt.

Parameters:

• retryMaxAttempts: The maximum number of retry attempts.
• retryBackoffMs: The backoff time in milliseconds between retry attempts.

LocalStorage

Methods

• enqueue
• enqueueBatch
• dequeue
• peek
• clear
• getQueueLength

enqueue

enqueueBatch

dequeue

peek

clear

getQueueLength

LocalQueue

Handle the queueing, batching, and flushing of items.

The flushTimer ensures that any items in the queue are flushed at the specified interval. If the batchSize is reached, the queue will flush immediately.

Methods

• add
• addBatch
• forceFlush
• clear
• getQueueLength
• getItems

add

Add a single item to the queue.

The queue will flush if the batchSize is reached or after the flushInterval seconds has passed. If the queue is full, an error will be thrown and the item will not be added.

Parameters:

• item: - The item to add to the queue

addBatch

Add a batch of items to the queue.

The queue will flush if the batchSize is reached or after the flushInterval seconds has passed. If the queue is full, an error will be thrown.

Parameters:

• items: - The items to add to the queue

forceFlush

clear

getQueueLength

getItems

RetryHandler

Given a function that accepts a single payload, try to execute it. On failure, retry with exponential backoff.

Interfaces

• Storage
• LocalQueueOptions

Storage

LocalQueueOptions