@realm/react
Version:
React specific hooks and implementation helpers for Realm
12 lines • 520 B
TypeScript
import Realm from "realm";
export type UseRealmHook = {
(): Realm;
};
/**
* Generates a `useRealm` hook given a RealmContext. This allows access to the {@link Realm}
* instance anywhere within the RealmProvider.
* @param RealmContext - The context containing the {@link Realm} instance
* @returns useRealm - Hook that is used to gain access to the {@link Realm} instance
*/
export declare const createUseRealm: (RealmContext: React.Context<Realm | null>) => UseRealmHook;
//# sourceMappingURL=useRealm.d.ts.map