FluidFramework/api-report/pact-map.api.md

API Report File for "@fluid-experimental/pact-map"

Do not edit this file. It is a report generated by API Extractor.

import { IChannelAttributes } from '@fluidframework/datastore-definitions';
import { IChannelFactory } from '@fluidframework/datastore-definitions';
import { IChannelStorageService } from '@fluidframework/datastore-definitions';
import { IFluidDataStoreRuntime } from '@fluidframework/datastore-definitions';
import { IFluidSerializer } from '@fluidframework/shared-object-base';
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
import { ISharedObject } from '@fluidframework/shared-object-base';
import { ISharedObjectEvents } from '@fluidframework/shared-object-base';
import { ISummaryTreeWithStats } from '@fluidframework/runtime-definitions';
import { SharedObject } from '@fluidframework/shared-object-base';

// @public
export interface IPactMap<T = unknown> extends ISharedObject<IPactMapEvents> {
    delete(key: string): void;
    get(key: string): T | undefined;
    getPending(key: string): T | undefined;
    isPending(key: string): boolean;
    set(key: string, value: T | undefined): void;
}

// @public
export interface IPactMapEvents extends ISharedObjectEvents {
    (event: "pending" | "accepted", listener: (key: string) => void): any;
}

// @public
export class PactMap<T = unknown> extends SharedObject<IPactMapEvents> implements IPactMap<T> {
    constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes);
    // (undocumented)
    applyStashedOp(): void;
    static create(runtime: IFluidDataStoreRuntime, id?: string): PactMap;
    delete(key: string): void;
    get(key: string): T | undefined;
    static getFactory(): IChannelFactory;
    getPending(key: string): T | undefined;
    // @internal (undocumented)
    protected initializeLocalCore(): void;
    isPending(key: string): boolean;
    // @internal (undocumented)
    protected loadCore(storage: IChannelStorageService): Promise<void>;
    // @internal (undocumented)
    protected onDisconnect(): void;
    // @internal
    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
    // @internal (undocumented)
    protected reSubmitCore(content: unknown, localOpMetadata: unknown): void;
    set(key: string, value: T | undefined): void;
    // @internal
    protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats;
}

// (No @packageDocumentation comment for this package)