rxdb/dist/esm/plugins/react/database-provider.js

A local-first realtime NoSQL Database for JavaScript applications - https://rxdb.info/

import React from 'react';
import { isRxDatabase } from "../../rx-database.js";
import { Provider } from "./database-context.js";
import { newRxError } from "../../rx-error.js";
/**
 * RxDatabaseProvider is a React context provider component for RxDB.
 * It ensures that a valid RxDatabase instance is passed and makes it available
 * to all descendant components via React Context.
 *
 * @param {RxDatabaseProviderProps} props - The provider props.
 * @param {RxDatabase} props.database - The RxDatabase instance to provide.
 * @param {React.ReactNode} props.children - The child components that will have access to the database.
 * @throws {Error} If the provided database is not a valid RxDatabase instance.
 * @returns {ReactElement} The context provider wrapping the children.
 *
 * @example
 * <RxDatabaseProvider database={myDatabase}>
 *   <MyComponent />
 * </RxDatabaseProvider>
 */
export function RxDatabaseProvider({
  children,
  database
}) {
  if (!isRxDatabase(database)) {
    throw newRxError('R1', {
      database
    });
  }
  return /*#__PURE__*/React.createElement(Provider, {
    value: database
  }, children);
}
//# sourceMappingURL=database-provider.js.map