1.3.0 • Published 3 years ago
@quara-dev/react-nats-context v1.3.0
react-nats-context
NATS client as a React Context
Install
react-nats-context
depends on react
and react-dom
. Those dependencies should be installed as well if that's not already the case:
npm i @quara-dev/react-nats-context react-dom react
Usage
- The
NatsProvider
context can be used to inject anNATS Connection
into a React application. Below is an example withnextjs
:
import { NatsProvider } from "@quara-dev/react-nats-context";
export default MyPage = (pageProps) => {
return (
<NatsProvider
maxReconnectAttempts={1000}
servers={["ws://localhost:10443"]}
tls={false}
>
<Component {...pageProps} />
</NatsProvider>
);
};
- The
useNats
hook can then be used to fetch theNATS Connection
from any React component within the component tree.
import { useNats } from "@quara-dev/react-nats-context";
export const PublishButton () => {
const { connected, publishText } = useNats()
return (
<button
isDisabled={!connected}
onClick={() => publishText("subject", "hello world")}
>
Publish
</button>
)
}
- The
useRequest
hook can be used to perform a request asynchronously while component is being displayed:
import type { NextPage } from "next";
import { Empty, loadText, useRequest } from "@quara-dev/react-nats-context";
import { Text, Code, Button } from "@chakra-ui/react";
const UseRequestExample = () => {
/**
* Request will be fired automatically because "auto" is set to true.
* It is then possible to return some UI elements according to request state.
*/
const request = useRequest("demo", Empty, { auto: true });
// When request failed
if (request.error) {
return (
<>
<Text mt="10rem">
Aie ! An error occured:{" "}
<Code>
// Additional information might be available on request.error attribute
{JSON.stringify({
message: request.error.message,
code: request.error.code,
description: request.error.description,
name: request.error.name,
})}
</Code>
</Text>
// Refresh request on click
<Button onClick={() => request.refresh()}>Refresh</Button>
</>
);
}
// When request is still on-going
if (request.loading) {
return <Text mt="10rem">Waiting for reply...</Text>;
}
// When request was successfull
if (request.result) {
return (
<>
<Text mt="10rem">
// Parse response data as string
Got a response : <Code>{loadText(request.result.data)}</Code>
</Text>
// Refresh the request on click
<Button onClick={() => request.refresh()}>Refresh</Button>
</>
);
}
// When no request has been performed yet, I.E, client is not connected
return (
<>
<Text mt="10rem">Not doing anything</Text>
// Refresh the request on click
<Button onClick={() => request.refresh()}>Refresh</Button>
</>
);
};
export default UseRequestExample;
Minimal subscription example
Below is an example of a Next.js application page using a subscription:
import type { NextPage } from "next";
import {
dumpText,
loadText,
useSubscription,
Msg,
NatsError,
} from "@quara-dev/react-nats-context";
import { Text } from "@chakra-ui/react";
const MinimalExample: NextPage = () => {
/**
* A callback that will be used to process messages
*/
const callback = (error: NatsError | null, msg: Msg) => {
if (error) {
console.error(error);
return;
}
alert(`Received new message: ${loadText(msg.data)}`);
msg.respond(dumpText("Ack"));
};
/**
* Use the useSubscription hook to start a subscription in the background
* (only when client is connected)
*/
const { connected, connecting, reconnecting, closed } = useSubscription(
"demo",
{ callback }
);
/**
* Display a component that gets updated on connection status update
*/
if (connected) {
return <Text>Up and running</Text>;
} else if (connecting) {
return (
<Text>Wait a little bit, the app is connecting to the NATS server</Text>
);
} else if (reconnecting) {
return <Text>Reconnecting to the NATS server</Text>;
} else if (closed) {
return <Text>No connection to NATS server</Text>;
} else {
return <Text>Aie ! Disconnected from the NATS server</Text>;
}
};
export default MinimalExample;
Display connection status using a circular progress
Check out chakra-ui CircularProgress usage
import { CircularProgress, CircularProgressProps } from "@chakra-ui/react";
import { useNats } from "@quara-dev/react-nats-context";
export const ConnectionStatus = (props: CircularProgressProps) => {
// Each variable is a boolean state that gets updated on the fly
const { reconnecting, connecting, connected, connect } = useNats();
// The NATS client is not initialized yet, we're connecting for the first time
if (connecting) {
return <CircularProgress isIndeterminate color="blue.300" {...props} />;
}
// The NATS client is reconnecting to NATS server
if (reconnecting) {
return <CircularProgress isIndeterminate color="orange.300" {...props} />;
}
// The NATS client is already connected
if (connected) {
return <CircularProgress value={100} color="green.300" {...props} />;
}
return (
<CircularProgress
value={100}
color="red.500"
{...props}
onClick={connect}
/>
);
};
Features
/**
* Those imports can be used for typing only
*/
import type {
NatsContextAttrs,
NatsContextProps,
NatsConnection,
NatsError,
ConnectionOptions,
PublishOptions,
RequestOptions,
SubscriptionOptions,
Subscription,
Msg,
TextMsg,
JsonMsg,
} from "@quara-dev/react-nats-context";
/**
* Those imports can be used as values
*/
import {
Empty,
NatsContext,
NatsProvider,
dumpText,
dumpJSON,
loadText,
loadJSON,
useNats,
useSubscription
} from "@quara-dev/react-nats-context";
/**
* You can find below all attributes that are available on an NATS context
*/
export const MyComponent () => {
const {
nc,
connect,
close,
reconnect,
update,
connected,
connecting,
reconnecting,
closed,
subscribe,
publish,
publishText,
publishJson,
request,
requestText,
requestJson,
} = useNats()
/**
* There is also a hook to subscribe to a subject
*/
const {
sub,
connected,
connecting,
reconnecting,
closed,
update,
} = useSubscription("foo")
}
1.2.0
3 years ago
1.3.0-rc7
3 years ago
1.2.8
3 years ago
1.1.9
3 years ago
1.3.0-rc6
3 years ago
1.2.7
3 years ago
1.3.0-rc9
3 years ago
1.2.6
3 years ago
1.3.0-rc8
3 years ago
1.2.5
3 years ago
1.2.4
3 years ago
1.3.0-beta0
3 years ago
1.3.0
3 years ago
1.2.1
3 years ago
1.3.0-rc1
3 years ago
1.3.0-rc11
3 years ago
1.3.0-rc3
3 years ago
1.3.0-rc12
3 years ago
1.3.0-rc2
3 years ago
1.3.0-rc5
3 years ago
1.3.0-rc10
3 years ago
1.3.0-rc4
3 years ago
1.3.0-rc15
3 years ago
1.3.0-rc16
3 years ago
1.3.0-rc13
3 years ago
1.1.10
3 years ago
1.3.0-rc14
3 years ago
1.3.0-rc17
3 years ago
1.3.0-rc18
3 years ago
1.2.2-rc4
3 years ago
1.2.2-rc3
3 years ago
1.2.2-rc2
3 years ago
1.2.2-rc1
3 years ago
1.2.2-rc5
3 years ago
1.1.8
3 years ago
1.1.7
3 years ago
1.1.6
3 years ago
1.1.5
3 years ago
1.1.4
3 years ago
1.1.3
3 years ago
1.1.2
3 years ago
1.1.1
3 years ago
1.1.0
3 years ago