@first-team-339/ntcore-react
Version:
React bindings for ntcore-ts-client.
18 lines (17 loc) • 915 B
TypeScript
type NTProviderProps = {
children?: React.ReactNode;
port?: number;
teamNumber?: number;
uri?: string;
};
/**
* Used to give the rest of the application access to the network tables connection. This component should be placed at the top of the component tree.
* Pass in either a uri or a team number to create a network tables connection. If a uri is provided, the connection will be created using that uri. If a team number is provided, the connection will be created using the team number. If a uri is provided, the team number will be ignored.
*
* @param uri The uri of the network tables server
* @param teamNumber The team number of the network tables server
* @param port The port of the network tables server. Defaults to 5810
* @returns
*/
export default function NTProvider({ children, uri, teamNumber, port, }: NTProviderProps): import("react/jsx-runtime").JSX.Element;
export {};