Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "nbformat/src/index"

Index

Type aliases

CellType

CellType: "code" | "markdown" | "raw"

A type which describes the type of cell.

ExecutionCount

ExecutionCount: number | null

The code cell's prompt number. Will be null if the cell has not been run.

ICell

A cell union type.

ICellMetadata

A union metadata type.

IOutput

An output union type.

MultilineString

MultilineString: string | string[]

A multiline string.

OutputMetadata

OutputMetadata: PartialJSONObject

Cell output metadata.

OutputType

OutputType: "execute_result" | "display_data" | "stream" | "error" | "update_display_data"

The valid output types.

StreamType

StreamType: "stdout" | "stderr"

An alias for a stream type.

Variables

Const MAJOR_VERSION

MAJOR_VERSION: number = 4

The major version of the notebook format.

Const MINOR_VERSION

MINOR_VERSION: number = 4

The minor version of the notebook format.

Functions

isCode

  • isCode(cell: ICell): cell is ICodeCell

isDisplayData

  • isDisplayData(output: IOutput): output is IDisplayData

isDisplayUpdate

  • isDisplayUpdate(output: IOutput): output is IDisplayUpdate

isError

  • isError(output: IOutput): output is IError

isExecuteResult

  • isExecuteResult(output: IOutput): output is IExecuteResult

isMarkdown

  • isMarkdown(cell: ICell): cell is IMarkdownCell

isRaw

  • isRaw(cell: ICell): cell is IRawCell

isStream

  • isStream(output: IOutput): output is IStream

validateMimeValue

  • validateMimeValue(type: string, value: MultilineString | PartialJSONObject): boolean
  • Validate a mime type/value pair.

    Parameters

    • type: string

      The mimetype name.

    • value: MultilineString | PartialJSONObject

      The value associated with the type.

    Returns boolean

    Whether the type/value pair are valid.

Generated using TypeDoc