@casual-simulation/aux-runtime/runtime/AuxRealtimeEditModeProvider.d.ts

Runtime for AUX projects

import { RealtimeEditMode } from './RuntimeBot';
/**
 * The default realtime edit mode.
 */
export declare const DEFAULT_REALTIME_EDIT_MODE: RealtimeEditMode;
/**
 * A map between space types and the realtime edit modes they should use.
 */
export type SpaceRealtimeEditModeMap = Map<string, RealtimeEditMode>;
/**
 * The default map between bot spaces and realtime edit modes.
 */
export declare const DEFAULT_SPACE_REALTIME_EDIT_MODE_MAP: SpaceRealtimeEditModeMap;
/**
 * Gets the realtime edit mode for the given space and map.
 * @param map The map.
 * @param space The space.
 */
export declare function getRealtimeEditMode(map: SpaceRealtimeEditModeMap, space: string): RealtimeEditMode;
/**
 * Defines an interface for an object that is able to provide realtime edit modes for a particular partition key.
 */
export interface AuxRealtimeEditModeProvider {
    /**
     * Gets the edit mode for the given space.
     * @param space The space.
     */
    getEditMode(space: string): RealtimeEditMode;
}
export declare class DefaultRealtimeEditModeProvider implements AuxRealtimeEditModeProvider {
    private _map;
    constructor(map?: SpaceRealtimeEditModeMap);
    getEditMode(space: string): RealtimeEditMode;
}
//# sourceMappingURL=AuxRealtimeEditModeProvider.d.ts.map