OutputChannel | Theia TypeDoc

Hierarchy

OutputChannel

Implements

Disposable

Index

Constructors

constructor

new OutputChannel(resource: OutputResource, preferences: OutputPreferences): OutputChannel

- Defined in packages/output/src/browser/output-channel.ts:221
Parameters
- resource: OutputResource
- preferences: OutputPreferences
Returns OutputChannel

Properties

Protected _maxLineNumber

_maxLineNumber: number

Protected Readonly contentChangeEmitter

contentChangeEmitter: Emitter<void> = ...

Protected decorationIds

decorationIds: Set<string> = ...

Protected disposed

disposed: boolean = false

Protected Readonly disposedEmitter

disposedEmitter: Emitter<void> = ...

Readonly onContentChange

onContentChange: Event<void> = ...

Readonly onDisposed

onDisposed: Event<void> = ...

Readonly onVisibilityChange

onVisibilityChange: Event<{ isVisible: boolean; preserveFocus?: boolean }> = ...

Protected Readonly preferences

preferences: OutputPreferences

Protected Readonly resource

resource: OutputResource

Protected Readonly textModifyQueue

textModifyQueue: PQueue<DefaultAddOptions> = ...

Protected Readonly toDispose

toDispose: DisposableCollection = ...

Protected Readonly visibilityChangeEmitter

visibilityChangeEmitter: Emitter<{ isVisible: boolean; preserveFocus?: boolean }> = ...

Protected visible

visible: boolean = true

Accessors

isVisible

get isVisible(): boolean

- Defined in packages/output/src/browser/output-channel.ts:261
Note: if false it does not meant it is disposed or not available, it is only hidden from the UI.

Returns boolean

Protected maxLineNumber

get maxLineNumber(): number
set maxLineNumber(maxLineNumber: number): void

- Defined in packages/output/src/browser/output-channel.ts:357
Returns number
- Defined in packages/output/src/browser/output-channel.ts:361
Parameters
- maxLineNumber: number
Returns void

name

get name(): string

- Defined in packages/output/src/browser/output-channel.ts:235
Returns string

uri

get uri(): URI

- Defined in packages/output/src/browser/output-channel.ts:239
Returns URI

Methods

append

append(content: string, severity?: OutputChannelSeverity): void

- Defined in packages/output/src/browser/output-channel.ts:284
Parameters
- content: string
- severity: OutputChannelSeverity = OutputChannelSeverity.Info
Returns void

appendLine

appendLine(content: string, severity?: OutputChannelSeverity): void

- Defined in packages/output/src/browser/output-channel.ts:288
Parameters
- content: string
- severity: OutputChannelSeverity = OutputChannelSeverity.Info
Returns void

clear

clear(): void

- Defined in packages/output/src/browser/output-channel.ts:265
Returns void

dispose

dispose(): void

Implementation of Disposable.dispose
- Defined in packages/output/src/browser/output-channel.ts:275
Returns void

Protected doAppend

doAppend(__namedParameters: { appendEol?: boolean; content: string; severity: OutputChannelSeverity }): Promise<void>

- Defined in packages/output/src/browser/output-channel.ts:292
Parameters
- __namedParameters: { appendEol?: boolean; content: string; severity: OutputChannelSeverity }
  - Optional appendEol?: boolean
  - content: string
  - severity: OutputChannelSeverity
Returns Promise<void>

Protected ensureMaxChannelHistory

ensureMaxChannelHistory(textModel: ITextModel): void

- Defined in packages/output/src/browser/output-channel.ts:328
Parameters
- textModel: ITextModel
Returns void

hide

hide(): void

- Defined in packages/output/src/browser/output-channel.ts:243
Returns void

show

show(__namedParameters?: { preserveFocus: boolean }): void

- Defined in packages/output/src/browser/output-channel.ts:253
If preserveFocus is true, the channel will not take focus. It is false by default.
- Calling show without args or with preserveFocus: false will reveal and activate the Output widget.
- Calling show with preserveFocus: true will reveal the Output widget but won't activate it.
Parameters
- __namedParameters: { preserveFocus: boolean } = ...
  - preserveFocus: boolean
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

resource: OutputResource

preferences: OutputPreferences

Returns OutputChannel

Properties

Protected _maxLineNumber

Protected Readonly contentChangeEmitter

Protected decorationIds

Protected disposed

Protected Readonly disposedEmitter

Readonly onContentChange

Readonly onDisposed

Readonly onVisibilityChange

Protected Readonly preferences

Protected Readonly resource

Protected Readonly textModifyQueue

Protected Readonly toDispose

Protected Readonly visibilityChangeEmitter

Protected visible

Accessors

isVisible

Returns boolean

Protected maxLineNumber

Returns number

Parameters

maxLineNumber: number

Returns void

name

Returns string

uri

Returns URI

Methods

append

Parameters

content: string

severity: OutputChannelSeverity = OutputChannelSeverity.Info

Returns void

appendLine

Parameters

content: string

severity: OutputChannelSeverity = OutputChannelSeverity.Info

Returns void

clear

Returns void

dispose

Returns void

Protected doAppend

Parameters

__namedParameters: { appendEol?: boolean; content: string; severity: OutputChannelSeverity }

Optional appendEol?: boolean

content: string

severity: OutputChannelSeverity

Returns Promise<void>

Protected ensureMaxChannelHistory

Parameters

textModel: ITextModel

Returns void

hide

Returns void

show

Parameters

__namedParameters: { preserveFocus: boolean } = ...

preserveFocus: boolean

Returns void