Module docprovider

Index

Namespaces

Classes

Interfaces

IDocumentProvider

Type aliases

IDocumentProviderFactory

Variables

Functions

Type aliases

IDocumentProviderFactory

IDocumentProviderFactory<T>: (options: IOptions<T>) => IDocumentProvider

Type parameters

T: ISharedDocument = ISharedDocument

Type declaration

- (options: IOptions<T>): IDocumentProvider
- The type for the document provider factory.
  
  Parameters
  - options: IOptions<T>
  Returns IDocumentProvider

Variables

Const IDocumentProviderFactory

IDocumentProviderFactory: Token<IDocumentProviderFactory<ISharedDocument>>

The default document provider token.

Const moonsOfJupyter

moonsOfJupyter: string[] = ...

From https://en.wikipedia.org/wiki/Moons_of_Jupiter

deprecated: in favor of user service. Will be removed in v4.0

Const userColors

userColors: string[] = ...

deprecated: in favor of user service. Will be removed in v4.0

Functions

Const getAnonymousUserName

getAnonymousUserName(): string

- Defined in packages/docprovider/src/awareness.ts:94
Get a random user-name based on the moons of Jupyter. This function returns names like "Anonymous Io" or "Anonymous Metis".

deprecated

in favor of user service. Will be removed in v4.0

Returns string

Const getRandomColor

getRandomColor(): string

- Defined in packages/docprovider/src/awareness.ts:115
deprecated

in favor of user service. Will be removed in v4.0

Returns string

Generated using TypeDoc