Saveable | Theia TypeDoc

Index

Interfaces

RevertOptions

Type Aliases

Snapshot

Functions

Type Aliases

Snapshot

Snapshot: { value: string } | { read: any }

Functions

apply

apply(widget: Widget, getOtherSaveables?: (() => (Widget | SaveableWidget)[]), doSave?: ((widget: Widget, options?: SaveOptions) => Promise<void>)): SaveableWidget | undefined

- Defined in packages/core/src/browser/saveable.ts:167
Parameters
- widget: Widget
- Optional getOtherSaveables: (() => (Widget | SaveableWidget)[])
  - - (): (Widget | SaveableWidget)[]
    - Returns (Widget | SaveableWidget)[]
- Optional doSave: ((widget: Widget, options?: SaveOptions) => Promise<void>)
  - - (widget: Widget, options?: SaveOptions): Promise<void>
    - Parameters
      - widget: Widget
      - Optional options: SaveOptions
      Returns Promise<void>
Returns SaveableWidget | undefined

confirmSaveBeforeClose

confirmSaveBeforeClose(toClose: Iterable<Widget>, others: Widget[]): Promise<boolean | undefined>

- Defined in packages/core/src/browser/saveable.ts:137
Parameters
- toClose: Iterable<Widget>
- others: Widget[]
Returns Promise<boolean | undefined>

get

get(arg: unknown): Saveable | undefined

- Defined in packages/core/src/browser/saveable.ts:69
Parameters
- arg: unknown
Returns Saveable | undefined

getDirty

getDirty(arg: unknown): Saveable | undefined

- Defined in packages/core/src/browser/saveable.ts:78
Parameters
- arg: unknown
Returns Saveable | undefined

is

is(arg: unknown): arg is Saveable

- Defined in packages/core/src/browser/saveable.ts:66
Parameters
- arg: unknown
Returns arg is Saveable

isDirty

isDirty(arg: unknown): boolean

- Defined in packages/core/src/browser/saveable.ts:85
Parameters
- arg: unknown
Returns boolean

isSource

isSource(arg: unknown): arg is SaveableSource

- Defined in packages/core/src/browser/saveable.ts:63
Parameters
- arg: unknown
Returns arg is SaveableSource

save

save(arg: unknown, options?: SaveOptions): Promise<void>

- Defined in packages/core/src/browser/saveable.ts:88
Parameters
- arg: unknown
- Optional options: SaveOptions
Returns Promise<void>

shouldSave

shouldSave(saveable: Saveable, cb: (() => MaybePromise<undefined | boolean>)): Promise<boolean | undefined>

- Defined in packages/core/src/browser/saveable.ts:190
Parameters
- saveable: Saveable
- cb: (() => MaybePromise<undefined | boolean>)
  - - (): MaybePromise<undefined | boolean>
    - Returns MaybePromise<undefined | boolean>
Returns Promise<boolean | undefined>

Index

Interfaces

Type Aliases

Functions

Type Aliases

Snapshot

Functions

apply

Parameters

widget: Widget

Optional getOtherSaveables: (() => (Widget | SaveableWidget)[])

Returns (Widget | SaveableWidget)[]

Optional doSave: ((widget: Widget, options?: SaveOptions) => Promise<void>)

Parameters

widget: Widget

Optional options: SaveOptions

Returns Promise<void>

Returns SaveableWidget | undefined

confirmSaveBeforeClose

Parameters

toClose: Iterable<Widget>

others: Widget[]

Returns Promise<boolean | undefined>

get

Parameters

arg: unknown

Returns Saveable | undefined

getDirty

Parameters

arg: unknown

Returns Saveable | undefined

is

Parameters

arg: unknown

Returns arg is Saveable

isDirty

Parameters

arg: unknown

Returns boolean

isSource

Parameters

arg: unknown

Returns arg is SaveableSource

save

Parameters

arg: unknown

Optional options: SaveOptions

Returns Promise<void>

shouldSave

Parameters

saveable: Saveable

cb: (() => MaybePromise<undefined | boolean>)

Returns MaybePromise<undefined | boolean>

Returns Promise<boolean | undefined>