Doc - Documentation

Constructor

new Doc(valueopt)

Description:

Constructor

Source:

doc.js, line 14

Parameters:

Name Type Attributes Description

value

string | object

Document name or value

Properties

Name	Attributes	Description
`name`	<optional>	Document name
`mime`	<optional>	Document MIME type
`content`	<optional>	Document content

Methods

getContent() → {string}

Description:

Get the document content (encoded in base 64)

Source:

doc.js, line 118

Returns:

Content

Type: string

getContentAsArrayBuffer() → {ArrayBuffer}

Description:

Get the document content as an array buffer

Source:

doc.js, line 144

Returns:

Content as an array buffer

Type: ArrayBuffer

getContentAsText() → {string}

Description:

Get the document content as a text

Source:

doc.js, line 160

Returns:

Content as plain text

Type: string

getDataURL(thumbnailopt) → {string}

Description:

Get the document data URL

Source:

doc.js, line 189

Parameters:

Name	Type	Attributes	Default	Description
`thumbnail`	boolean	<optional>	`false`	Thumbnail? If thumbnail does not exists the content is used.

Returns:

Data URL or nothing if content is empty

Type: string

getFileName() → {string}

Description:

Alias to getName

Source:

doc.js, line 40

Returns:

Name

Type: string

getFilename() → {string}

Description:

Alias to getName

Source:

doc.js, line 46

Returns:

Name

Type: string

getId() → {string}

Description:

Get the document ID

Source:

doc.js, line 71

Returns:

Type: string

getMIMEType() → {string}

Description:

Get the document MIME type

Source:

doc.js, line 79

Returns:

MIME type

Type: string

getMimeType() → {string}

Description:

Alias to getMIMEType

Source:

doc.js, line 28

Returns:

MIME type

Type: string

getName() → {string}

Description:

Get the document name

Source:

doc.js, line 97

Returns:

Name

Type: string

getThumbnail() → {string}

Description:

Get the document thumbnail (encoded in base 64)

Source:

doc.js, line 126

Returns:

Thumbnail

Type: string

getThumbnailAsArrayBuffer() → {ArrayBuffer}

Description:

Get the document thumbnail as an array buffer

Source:

doc.js, line 152

Returns:

Thumbnail as an array buffer

Type: ArrayBuffer

getValue() → {object}

Description:

Get the document as a plain value object

Source:

doc.js, line 229

Returns:

Value object

Type: object

load(file) → {promise.<Doc>}

Description:

Load file

Source:

doc.js, line 199

Parameters:

Name	Type	Description
`file`		File to load

Returns:

A promise to the document

Type: promise.<Doc>

setContent(content) → {Doc}

Description:

Set the document content

Source:

doc.js, line 169

Parameters:

Name	Type	Description
`content`	string	Content (encoded in base 64)

Returns:

This document for chaining

Type: Doc

setContentFromText(content) → {Doc}

Description:

Set the document content from plain text string

Source:

doc.js, line 179

Parameters:

Name	Type	Description
`content`	string	Content as plain text string

Returns:

This document for chaining

Type: Doc

setFileName(name)

Description:

Alias to setName

Source:

doc.js, line 52

Parameters:

Name	Type	Description
`name`	string	Name

setFilename(name)

Description:

Alias to setName

Source:

doc.js, line 58

Parameters:

Name	Type	Description
`name`	string	Name

setMIMEType(mime) → {Doc}

Description:

Set the document MIME type

Source:

doc.js, line 88

Parameters:

Name	Type	Description
`mime`	string	MIME type

Returns:

This document for chaining

Type: Doc

setMimeType(mime)

Description:

Alias to setMIMEType

Source:

doc.js, line 34

Parameters:

Name	Type	Description
`mime`	string	MIME type

setName(name) → {Doc}

Description:

Set the document name

Source:

doc.js, line 106

Parameters:

Name	Type	Description
`name`	string	Name

Returns:

This document for chaining

Type: Doc