Class NotebookCellOutputItem

One representation of a notebook output, defined by MIME type and data.

Implements

NotebookCellOutputItem

Index

Constructors

Properties

Methods

error json stderr stdout text

Constructors

constructor

new NotebookCellOutputItem(
data: Uint8Array,
mime: string,
): NotebookCellOutputItem
Parameters
- data: Uint8Array
- mime: string
Returns NotebookCellOutputItem
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1264

Properties

data

data: Uint8Array

The data of this output item. Must always be an array of unsigned 8-bit integers.

mime

mime: string

The mime type which determines how the data-property is interpreted.

Notebooks have built-in support for certain mime-types, extensions can add support for new types and override existing types.

Methods

`Static`error

error(value: Error): NotebookCellOutputItem
Factory function to create a NotebookCellOutputItem that uses uses the application/vnd.code.notebook.error mime type.
Parameters
- value: Error
  An error object.
Returns NotebookCellOutputItem
A new output item object.
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1260

`Static`json

json(value: any, mime?: string): NotebookCellOutputItem
eslint-disable-next-line @typescript-eslint/no-explicit-any
Parameters
- value: any
- Optionalmime: string
Returns NotebookCellOutputItem
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1247

`Static`stderr

stderr(value: string): NotebookCellOutputItem
Factory function to create a NotebookCellOutputItem that uses uses the application/vnd.code.notebook.stderr mime type.
Parameters
- value: string
  A string.
Returns NotebookCellOutputItem
A new output item object.
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1256

`Static`stdout

stdout(value: string): NotebookCellOutputItem
Factory function to create a NotebookCellOutputItem that uses uses the application/vnd.code.notebook.stdout mime type.
Parameters
- value: string
  A string.
Returns NotebookCellOutputItem
A new output item object.
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1252

`Static`text

text(value: string, mime?: string): NotebookCellOutputItem
Factory function to create a NotebookCellOutputItem from a string.

Note that an UTF-8 encoder is used to create bytes for the string.
Parameters
- value: string
  A string.
- Optionalmime: string
  Optional MIME type, defaults to text/plain.
Returns NotebookCellOutputItem
A new output item object.
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1241