Interface IModelFactory<T, U>

The interface for a model factory.

interface IModelFactory<
    T extends DocumentRegistry.IModel,
    U extends ISharedDocument = ISharedDocument,
> {
    collaborative?: boolean;
    contentType: string;
    fileFormat: FileFormat;
    isDisposed: boolean;
    name: string;
    createNew(options?: DocumentRegistry.IModelOptions<U>): T;
    dispose(): void;
    preferredLanguage(path: string): string;
}

Type Parameters

Hierarchy

Implemented by

Properties

collaborative? contentType fileFormat isDisposed name

Methods

createNew dispose preferredLanguage

Properties

Optional Readonlycollaborative

collaborative?: boolean

Whether the model is collaborative or not.

ReadonlycontentType

contentType: string

The content type of the file (defaults to "file").

ReadonlyfileFormat

fileFormat: FileFormat

The format of the file (defaults to "text").

ReadonlyisDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonlyname

name: string

The name of the model.

Methods

createNew

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

preferredLanguage

Settings

Member Visibility

On This Page

Properties
Methods