rxdb/dist/types/plugin-helpers.d.ts

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

import { WrappedRxStorageInstance } from './rx-storage-helper.ts';
import type { RxDocumentData, RxDocumentWriteData, RxJsonSchema, RxStorage, RxStorageInstance, RxValidationError, MaybePromise } from './types/index.d.ts';
type WrappedStorageFunction = <Internals, InstanceCreationOptions>(args: {
    storage: RxStorage<Internals, InstanceCreationOptions>;
}) => RxStorage<Internals, InstanceCreationOptions>;
/**
 * Returns the validation errors.
 * If document is fully valid, returns an empty array.
 */
type ValidatorFunction = (docData: RxDocumentData<any>) => RxValidationError[];
/**
 * This factory is used in the validation plugins
 * so that we can reuse the basic storage wrapping code.
 */
export declare function wrappedValidateStorageFactory(
/**
 * Returns a method that can be used to validate
 * documents and throws when the document is not valid.
 */
getValidator: (schema: RxJsonSchema<any>) => ValidatorFunction, 
/**
 * A string to identify the validation library.
 */
validatorKey: string): WrappedStorageFunction;
/**
 * Used in plugins to easily modify all in- and outgoing
 * data of that storage instance.
 */
export declare function wrapRxStorageInstance<RxDocType>(originalSchema: RxJsonSchema<RxDocumentData<RxDocType>>, instance: RxStorageInstance<RxDocType, any, any>, modifyToStorage: (docData: RxDocumentWriteData<RxDocType>) => MaybePromise<RxDocumentData<any>>, modifyFromStorage: (docData: RxDocumentData<any>) => MaybePromise<RxDocumentData<RxDocType>>, modifyAttachmentFromStorage?: (attachmentData: string) => MaybePromise<string>): WrappedRxStorageInstance<RxDocType, any, any>;
export {};