6.0.2 • Published 7 months ago
readable-hook v6.0.2
Readable Hook
React hooks for wrangling ReadableStream
s.
Installation
npm i readable-hook --save
Usage
useStreamingQuery
const MyComponent: FC = () => {
const [{ value }, triggerQuery] = useStreamingQuery('path/to/api/endpoint');
return (
<div>
{value}
<button onClick={fetchStreamingData} />
</div>
);
};
useStreamingMutation
Allows synchronizing state with a mutation endpoint that returns a streaming response. Has a few different ways to pass parameters (at init, and at mutation trigger).
const MyComponent: FC = () => {
const [{ value, isStreaming, done }, triggerMutation] = useStreamingMutation('path/to/api/endpoint', {
// params that can be passed during initialization
});
return (
<div>
{value}
<input onSubmit={e => triggerMutation({
params: {
inputValue: e.target.value
},
onDone: () => console.log("Done streaming")
})} />
</div>
);
};
useReadableHook
Allows synchronizing state with a ReadableStream
.
Check this for a working example.
const MyComponent: FC<{ readableStream: ReadableStream }> = ({ readableStream }) => {
const [{ value }, synchronize] = useReadable(async () => readableStream, 100);
return (
<div>
{value}
<button onClick={synchronize} />
</div>
);
};
6.0.2
7 months ago
6.0.1
8 months ago
6.0.0
8 months ago
5.0.0
10 months ago
4.0.0
11 months ago
3.0.3
11 months ago
3.0.2
11 months ago
3.0.1
11 months ago
2.3.0
11 months ago
2.2.0
11 months ago
2.1.3
11 months ago
2.1.2
11 months ago
2.1.1
11 months ago
2.1.0
11 months ago
2.0.0
11 months ago
1.1.0
11 months ago
1.0.1
12 months ago
1.0.0
12 months ago