Liking cljdoc? Tell your friends :D

dots.vscode.notebook-cell-output-item

One representation of a {@link NotebookCellOutput notebook output}, defined by MIME type and data.

One representation of a {@link NotebookCellOutput notebook output}, defined by MIME type and data.
raw docstring

datacljs

(data notebook-cell-output-item)

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

Returns: Uint8Array

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

**Returns:** `Uint8Array`
sourceraw docstring

errorcljs

(error value)

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.

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.
sourceraw docstring

jsoncljs

(json value)
(json value mime)

Factory function to create a NotebookCellOutputItem from a JSON object.

Note that this function is not expecting "stringified JSON" but an object that can be stringified. This function will throw an error when the passed value cannot be JSON-stringified.

Parameters:

  • value: any - A JSON-stringifyable value.
  • mime: string | undefined - Optional MIME type, defaults to application/json

Returns: NotebookCellOutputItem - A new output item object.

Factory function to create a `NotebookCellOutputItem` from
a JSON object.

*Note* that this function is not expecting "stringified JSON" but
an object that can be stringified. This function will throw an error
when the passed value cannot be JSON-stringified.

**Parameters:**
- `value`: `any` - A JSON-stringifyable value.
- `mime`: `string | undefined` - Optional MIME type, defaults to `application/json`

**Returns:** `NotebookCellOutputItem` - A new output item object.
sourceraw docstring

mimecljs

(mime notebook-cell-output-item)

The mime type which determines how the {@linkcode NotebookCellOutputItem.data data}-property is interpreted.

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

Returns: string

The mime type which determines how the {@linkcode NotebookCellOutputItem.data data}-property
is interpreted.

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

**Returns:** `string`
sourceraw docstring

set-data!cljs

(set-data! notebook-cell-output-item value)

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

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

set-mime!cljs

(set-mime! notebook-cell-output-item value)

The mime type which determines how the {@linkcode NotebookCellOutputItem.data data}-property is interpreted.

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

The mime type which determines how the {@linkcode NotebookCellOutputItem.data data}-property
is interpreted.

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

stderrcljs

(stderr value)

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.

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.
sourceraw docstring

stdoutcljs

(stdout value)

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.

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.
sourceraw docstring

textcljs

(text value)
(text value mime)

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.
  • mime: string | undefined - Optional MIME type, defaults to text/plain.

Returns: NotebookCellOutputItem - A new output item object.

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.
- `mime`: `string | undefined` - Optional MIME type, defaults to `text/plain`.

**Returns:** `NotebookCellOutputItem` - A new output item object.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close