Home Manual Reference Source Test Repository

Function

Static Public Summary
public

get UTC date string.
public

markdown(text: string, breaks: boolean): string

convert markdown text to html.
public

parseExample(example: string): {body: string, caption: string}

parse @example value.
public

publish(values: DocObject[], asts: AST[], config: ESDocConfig)

publish document as HTML.
public

shorten(doc: DocObject, asMarkdown: boolean): string

shorten description.

Static Public

public dateForUTC(date: Date): string source 

import {dateForUTC} from 'esdoc/src/Publisher/Builder/util.js'

get UTC date string.

Params:

NameTypeAttributeDescription
date Date

target date object.

Return:

string

UTC date string(yyyy-mm-dd hh:mm:ss)

public markdown(text: string, breaks: boolean): string source 

import {markdown} from 'esdoc/src/Publisher/Builder/util.js'

convert markdown text to html.

Params:

NameTypeAttributeDescription
text string

markdown text.
breaks boolean
  • optional
  • default: false

if true, break line. FYI gfm is not breaks.

Return:

string

html.

public parseExample(example: string): {body: string, caption: string} source 

import {parseExample} from 'esdoc/src/Publisher/Builder/util.js'

parse @example value. @example value can have <caption> tag.

Params:

NameTypeAttributeDescription
example string

target example value.

Return:

{body: string, caption: string}

parsed example value.

public publish(values: DocObject[], asts: AST[], config: ESDocConfig) source 

import publish from 'esdoc/src/Publisher/publish.js'

publish document as HTML.

Params:

NameTypeAttributeDescription
values DocObject[]

all doc objects.
asts AST[]

all ASTs.
config ESDocConfig

ESDoc config object.

Test:

public shorten(doc: DocObject, asMarkdown: boolean): string source 

import {shorten} from 'esdoc/src/Publisher/Builder/util.js'

shorten description. e.g. this is JavaScript. this is Java. => this is JavaScript..

Params:

NameTypeAttributeDescription
doc DocObject

target doc object.
asMarkdown boolean
  • optional
  • default: false

is true, test as markdown and convert to html.

Return:

string

shorten description.

TODO:

  • shorten before process markdown.