react-query-firebase / web/firestore / UseEnsureDocOptions

Type Alias: UseEnsureDocOptions<AppModelType>

type UseEnsureDocOptions<AppModelType> = object & Omit<GetDocDataOptions<AppModelType>, "db">;

Defined in: web/firestore/useEnsureDoc.ts:13

Type declaration

defaults

defaults: AppModelType;

Reference to a document that must be written

options

options: Omit<UseQueryOptions<AppModelType, Error, AppModelType>, "queryFn"> & Required<Pick<UseQueryOptions<AppModelType, Error, AppModelType>, "queryKey">>;

Options for useMutation hook excluding mutationFn.

Type Parameters

AppModelType

AppModelType extends AppModel = AppModel