Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IOptions

The instantiation options for a WebSocketProvider.

Hierarchy

  • IOptions<YDocument<DocumentChange>>
    • IOptions

Index

Properties

Properties

Optional collaborative

collaborative: boolean

Whether the document provider should be collaborative.

contentType

contentType: string

Content type

format

format: string

The source format

model

model: YDocument<DocumentChange>

The shared model

path

path: string

The document file path

Optional translator

translator: TranslationBundle

The jupyterlab translator

url

url: string

The server URL

Optional user

user: IManager

The user data

Generated using TypeDoc