neft
Version:
JavaScript. Everywhere.
135 lines (102 loc) • 10.8 kB
Markdown
> [Wiki](Home) ▸ [[API Reference|API-Reference]] ▸ **Document**
# Document
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#document)
## Nested APIs
* [[Element|Document-Element-API]]
* [[Text|Document-Element.Text-API]]
* [[Tag|Document-Element.Tag-API]]
* [[neft:attr|Document-neft:attr-API]]
* [[Attributes evaluating|Document-Attributes evaluating-API]]
* [[Setting attributes|Document-Setting attributes-API]]
* [[neft:if|Document-neft:if-API]]
* [[neft:fragment|Document-neft:fragment-API]]
* [[neft:require|Document-neft:require-API]]
* [[id|Document-id-API]]
* [[neft:each|Document-neft:each-API]]
* [[neft:rule|Document-neft:rule-API]]
* [[neft:script|Document-neft:script-API]]
* [[neft:log|Document-neft:log-API]]
* [[String Interpolation|Document-String Interpolation-API]]
* [[neft:target|Document-neft:target-API]]
* [[neft:use|Document-neft:use-API]]
## Table of contents
* [Document](#document)
* [**Class** Document](#class-document)
* [onBeforeRender](#onbeforerender)
* [onRender](#onrender)
* [onBeforeRevert](#onbeforerevert)
* [onRevert](#onrevert)
* [fromHTML](#fromhtml)
* [fromElement](#fromelement)
* [fromJSON](#fromjson)
* [parse](#parse)
* [factory](#factory)
* [constructor](#constructor)
* [render](#render)
* [revert](#revert)
* [use](#use)
* [onReplaceByUse](#onreplacebyuse)
* [clone](#clone)
* [destroy](#destroy)
* [toJSON](#tojson)
* [Glossary](#glossary)
# **Class** Document
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#class-document)
##onBeforeRender
<dl><dt>Syntax</dt><dd><code>*Signal* Document.onBeforeRender(*Document* file)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>file — <a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
Corresponding node handler: *neft:onBeforeRender=""*.
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#onbeforerender)
##onRender
<dl><dt>Syntax</dt><dd><code>*Signal* Document.onRender(*Document* file)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>file — <a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
Corresponding node handler: *neft:onRender=""*.
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#onrender)
##onBeforeRevert
<dl><dt>Syntax</dt><dd><code>*Signal* Document.onBeforeRevert(*Document* file)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>file — <a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
Corresponding node handler: *neft:onBeforeRevert=""*.
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#onbeforerevert)
##onRevert
<dl><dt>Syntax</dt><dd><code>*Signal* Document.onRevert(*Document* file)</code></dd><dt>Static property of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>file — <a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
Corresponding node handler: *neft:onRevert=""*.
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#onrevert)
##fromHTML
<dl><dt>Syntax</dt><dd><code>*Document* Document.fromHTML(*String* path, *String* html)</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>path — <i>String</i></li><li>html — <i>String</i></li></ul></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#fromhtml)
##fromElement
<dl><dt>Syntax</dt><dd><code>*Document* Document.fromElement(*String* path, *Element* element)</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>path — <i>String</i></li><li>element — <a href="/Neft-io/neft/wiki/Document-Element-API#class-element">Element</a></li></ul></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#fromelement)
##fromJSON
<dl><dt>Syntax</dt><dd><code>*Document* Document.fromJSON(*String*|*Object* json)</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>json — <a href="/Neft-io/neft/wiki/Utils-API#isobject">Object</a> or <i>String</i></li></ul></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#fromjson)
##parse
<dl><dt>Syntax</dt><dd><code>Document.parse(*Document* file)</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>file — <a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></li></ul></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#parse)
##factory
<dl><dt>Syntax</dt><dd><code>*Document* Document.factory(*String* path)</code></dd><dt>Static method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>path — <i>String</i></li></ul></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#factory)
##constructor
<dl><dt>Syntax</dt><dd><code>Document::constructor(*String* path, *Element* element)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>path — <i>String</i></li><li>element — <a href="/Neft-io/neft/wiki/Document-Element-API#class-element">Element</a></li></ul></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#constructor)
#render
<dl><dt>Syntax</dt><dd><code>*Document* Document::render([*Any* props, *Any* root, *Document* source])</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>props — <i>Any</i> — <i>optional</i></li><li>root — <i>Any</i> — <i>optional</i></li><li>source — <a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a> — <i>optional</i></li></ul></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#render)
##revert
<dl><dt>Syntax</dt><dd><code>*Document* Document::revert()</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#revert)
##use
<dl><dt>Syntax</dt><dd><code>*Document* Document::use(*String* useName, [*Document* document])</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>useName — <i>String</i></li><li>document — <a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a> — <i>optional</i></li></ul></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#use)
##onReplaceByUse
<dl><dt>Syntax</dt><dd><code>*Signal* Document::onReplaceByUse(*Document.Use* use)</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Parameters</dt><dd><ul><li>use — <i>Document.Use</i></li></ul></dd><dt>Type</dt><dd><a href="/Neft-io/neft/wiki/Signal-API#class-signal">Signal</a></dd></dl>
Corresponding node handler: *neft:onReplaceByUse=""*.
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#onreplacebyuse)
##clone
<dl><dt>Syntax</dt><dd><code>*Document* Document::clone()</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#clone)
##destroy
<dl><dt>Syntax</dt><dd><code>Document::destroy()</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#destroy)
##toJSON
<dl><dt>Syntax</dt><dd><code>*Object* Document::toJSON()</code></dd><dt>Prototype method of</dt><dd><a href="/Neft-io/neft/wiki/Document-API#class-document">Document</a></dd><dt>Returns</dt><dd><a href="/Neft-io/neft/wiki/Utils-API#isobject">Object</a></dd></dl>
> [`Source`](/Neft-io/neft/blob/d00469ff300043eaadb5e0580f20f97425d44505/src/document/index.litcoffee#tojson)
# Glossary
- [Document](#class-document)