Sanity Library Reference Docs
    Preparing search index...

    Interface DocumentStoreBeta

    interface DocumentStore {
        initialValue: (
            opts: InitialValueOptions,
            context: InitialValueResolverContext,
        ) => Observable<InitialValueMsg>;
        listenQuery: (
            query: string | { fetch: string; listen: string },
            params: QueryParams,
            options: ListenQueryOptions,
        ) => Observable<any>;
        pair: {
            consistencyStatus: (
                publishedId: string,
                type: string,
                version?: string,
            ) => Observable<boolean>;
            editState: (
                publishedId: string,
                type: string,
                version?: string,
            ) => Observable<EditStateFor>;
            operationEvents: (
                publishedId: string,
                type: string,
            ) => Observable<OperationSuccess | OperationError>;
            validation: (
                validationTargetId: string,
                type: string,
                validatePublishedReferences: boolean,
            ) => Observable<ValidationStatus>;
        };
        resolveTypeForDocument: (
            id: string,
            specifiedType?: string,
        ) => Observable<string>;
    }
    Index

    Properties

    initialValue: (
        opts: InitialValueOptions,
        context: InitialValueResolverContext,
    ) => Observable<InitialValueMsg>
    listenQuery: (
        query: string | { fetch: string; listen: string },
        params: QueryParams,
        options: ListenQueryOptions,
    ) => Observable<any>
    pair: {
        consistencyStatus: (
            publishedId: string,
            type: string,
            version?: string,
        ) => Observable<boolean>;
        editState: (
            publishedId: string,
            type: string,
            version?: string,
        ) => Observable<EditStateFor>;
        operationEvents: (
            publishedId: string,
            type: string,
        ) => Observable<OperationSuccess | OperationError>;
        validation: (
            validationTargetId: string,
            type: string,
            validatePublishedReferences: boolean,
        ) => Observable<ValidationStatus>;
    }
    resolveTypeForDocument: (
        id: string,
        specifiedType?: string,
    ) => Observable<string>