FluidFramework/api-report/attributor.api.md

API Report File for "@fluidframework/attributor"

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

import { ContainerRuntime } from '@fluidframework/container-runtime';
import { IAudience } from '@fluidframework/container-definitions';
import { IDeltaManager } from '@fluidframework/container-definitions';
import { IDocumentMessage } from '@fluidframework/protocol-definitions';
import { ISequencedDocumentMessage } from '@fluidframework/protocol-definitions';
import { IUser } from '@fluidframework/protocol-definitions';

// @alpha
export interface AttributionInfo {
    timestamp: number;
    user: IUser;
}

// @alpha
export interface AttributionKey {
    seq: number;
    type: "op";
}

// @alpha
export class Attributor implements IAttributor {
    constructor(initialEntries?: Iterable<[number, AttributionInfo]>);
    // (undocumented)
    entries(): IterableIterator<[number, AttributionInfo]>;
    getAttributionInfo(key: number): AttributionInfo;
    // (undocumented)
    protected readonly keyToInfo: Map<number, AttributionInfo>;
    // (undocumented)
    tryGetAttributionInfo(key: number): AttributionInfo | undefined;
}

// @alpha (undocumented)
export function createRuntimeAttributor(): IRuntimeAttributor;

// @alpha
export const enableOnNewFileKey = "Fluid.Attribution.EnableOnNewFile";

// @alpha
export interface IAttributor {
    // (undocumented)
    entries(): IterableIterator<[number, AttributionInfo]>;
    getAttributionInfo(key: number): AttributionInfo;
    // (undocumented)
    tryGetAttributionInfo(key: number): AttributionInfo | undefined;
}

// @alpha (undocumented)
export interface IProvideRuntimeAttributor {
    // (undocumented)
    readonly IRuntimeAttributor: IRuntimeAttributor;
}

// @alpha (undocumented)
export const IRuntimeAttributor: keyof IProvideRuntimeAttributor;

// @alpha @sealed
export interface IRuntimeAttributor extends IProvideRuntimeAttributor {
    // (undocumented)
    get(key: AttributionKey): AttributionInfo;
    // (undocumented)
    has(key: AttributionKey): boolean;
}

// @alpha
export const mixinAttributor: (Base?: typeof ContainerRuntime) => typeof ContainerRuntime;

// @alpha
export class OpStreamAttributor extends Attributor implements IAttributor {
    constructor(deltaManager: IDeltaManager<ISequencedDocumentMessage, IDocumentMessage>, audience: IAudience, initialEntries?: Iterable<[number, AttributionInfo]>);
}

// (No @packageDocumentation comment for this package)