async
lifecycle
browser
utilities
What will you use the service for?
We batch analytics events for economy of scale. So far we tracked 0 events and sent 0 requests.
import { useBatchedCallback } from '@siberiacancode/reactuse';
import { useState } from 'react';
interface AnalyticsEvent {
action: 'deselected' | 'selected';
tag: string;
}
const INTERESTS = [
{ tag: 'work', label: 'Work' },
{ tag: 'study', label: 'Study' },
{ tag: 'hobby', label: 'Hobby' },
{ tag: 'business', label: 'Business' },
{ tag: 'creative', label: 'Creative' },
{ tag: 'team', label: 'Team' },
{ tag: 'research', label: 'Research' },
{ tag: 'fun', label: 'Fun' },
{ tag: 'other', label: 'Other' }
];
const Demo = () => {
const [tags, setTags] = useState<string[]>([]);
const [totalEvents, setTotalEvents] = useState(0);
const [requestsSent, setRequestsSent] = useState(0);
const sendAnalytics = useBatchedCallback<AnalyticsEvent[]>(
() => setRequestsSent((current) => current + 1),
{ size: 5, delay: 1500 }
);
const onToggle = (tag: string) => {
const isSelected = tags.includes(tag);
const action: AnalyticsEvent['action'] = isSelected ? 'deselected' : 'selected';
setTags((current) => (isSelected ? current.filter((item) => item !== tag) : [...current, tag]));
const event: AnalyticsEvent = { tag, action };
setTotalEvents((current) => current + 1);
sendAnalytics(event);
};
return (
<section className='flex max-w-md flex-col items-center gap-4'>
<div className='flex flex-col gap-1 text-center'>
<h3>What will you use the service for?</h3>
</div>
<div className='mb-6 flex flex-wrap justify-center gap-2'>
{INTERESTS.map((interest) => (
<button
key={interest.tag}
data-variant={tags.includes(interest.tag) ? 'outline' : 'default'}
type='button'
onClick={() => onToggle(interest.tag)}
>
{interest.label}
</button>
))}
</div>
<div className='flex flex-col gap-6 px-3 md:flex-row'>
<p className='text-muted-foreground text-center text-xs'>
We batch analytics events for economy of scale. So far we tracked{' '}
<code>{totalEvents}</code> events and sent <code>{requestsSent}</code> requests.
</p>
</div>
</section>
);
};
export default Demo;
Installation
pnpm add @siberiacancode/reactuseUsage
const delayed = useBatchedCallback((batch) => console.log(batch), { size: 5, delay: 1000 });Type Declarations
export type BatchedCallback<Params extends unknown[]> = ((...args: Params) => void) & {
flush: () => void;
cancel: () => void;
};
export interface UseBatchedCallbackOptions {
delay?: number;
size: number;
}API
Parameters
| Name | Type | Default | Note |
|---|---|---|---|
| callback | (batch: Params[]) => void | - | The callback that receives a batch of calls |
| options.size | number | - | The batch settings with size and optional delay |
| options.delay | number | 1000 | The delay (ms) after which pending calls are flushed |
Returns
BatchedCallback<Params>Contributors
ddebabin
Last updated on