CodeLine

CodeLine

Members

Fields & Properties
Methods
code-line.js:4

new CodeLine()

A line representing a line of code

Extends

Members

code-line.js:33

(static) markdownPattern

See:
code-line.js:41

(static) type

See:
type.js:25

content

Properties:
Name Type Description
content string

The human-readable content of the line
Inherited From:
type.js:33

groupType

Properties:
Name Type Description
groupType string

The type of group this line belongs to
Inherited From:
See:
type.js:40

isNesting

Properties:
Name Type Description
isNesting boolean

Whether this line is nestable in groups
Inherited From:
type.js:48

isSummarized

Properties:
Name Type Description
isSummarized boolean

Whether this line is included in a Canvas document summary
Inherited From:
type.js:55

source

Properties:
Name Type Description
source string

The original native source of this line
Inherited From:
type.js:63

type

Properties:
Name Type Description
type string

A human-readable name for this type
Inherited From:
See:
type.js:72

typeKey

Properties:
Name Type Description
typeKey string

A short, typically one-character key to denote this line type
Inherited From:
See:

Methods

code-line.js:71

(static) matchFence(markdown) → {boolean}

Determine if the Markdown text is a code fence.

Parameters
Name Type Description
markdown string

The Markdown to test as a possible code fence
Returns
Type
boolean
code-line.js:49

(static) matchMarkdown()

See:
  • Type.matchmarkdown
type.js:81

toJSON() → {object}

Inherited From:
Returns

An object representing this line in a JSON-serializable form

Type
object
type.js:97

toMarkdown(prev, next, contextopt) → {string}

Overrides:
Parameters
Name Type Attributes Default Description
prev Type

The line before the line being converted to Markdown
next Type

The line after the line being converted to Markdown
context object <optional>
 {}

Contextual information for the Markdown conversion
Returns

The Markdown representation of this line

Type
string