ISharedFile | @jupyter/ydoc (original) (raw)

Hierarchy

• ISharedDocumentNoSource
• ISharedText
  • ISharedFile

Implemented by

• YFile

Index

Properties

Readonly awareness

Readonly changed

Readonly disposed

Readonly isDisposed

isDisposed: boolean

source

source: string

Readonly state

Readonly version

version: string

Methods

canRedo

• canRedo(): boolean

• Returns boolean

canUndo

• canUndo(): boolean

• Returns boolean

clearUndoHistory

• clearUndoHistory(): void

• Returns void

dispose

• dispose(): void

• Returns void

getSource

• getSource(): string

• Returns string

getState

• getState(key: string): undefined | JSONValue

• Parameters

  • key: string

Returns undefined | JSONValue

redo

• redo(): void

• Returns void

setSource

• setSource(value: string): void

• Parameters

  • value: string

Returns void

setState

• setState(key: string, value: JSONValue): void

• Returns void

transact

• transact(f: (() => void), undoable?: boolean, origin?: any): void

• Parameters

  • f: (() => void)

    * * (): void  
             * #### Returns void  

  • Optional undoable: boolean

  • Optional origin: any

Returns void

undo

• undo(): void

• Returns void

updateSource

• updateSource(start: number, end: number, value?: string): void

• Parameters

  • start: number

  • end: number

  • Optional value: string

Returns void