Interface IModelFactory<T, U>

The interface for a model factory.

Type Parameters

Hierarchy

Implemented by

Properties

collaborative? contentType fileFormat isDisposed name

Methods

createNew dispose preferredLanguage

Properties

Optional Readonly collaborative

collaborative?: boolean

Whether the model is collaborative or not.

Readonly contentType

contentType: string

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

Readonly fileFormat

fileFormat: FileFormat

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

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly name

name: string

The name of the model.

Methods

createNew

  • Create a new model for a given path.

    Parameters

    Returns T

    A new document model.

dispose

  • 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

  • Get the preferred kernel language given a file path.

    Parameters

    • path: string

    Returns string

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc