From d89b68d9b69cf12ddf96da55a80fe246a6568f97 Mon Sep 17 00:00:00 2001 From: Ankit Kumar Date: Sun, 18 Dec 2022 21:22:23 +0530 Subject: [PATCH] generate output --- output/v4/Alive.html | 188 +---------- output/v4/Alive.js.html | 59 +--- output/v4/Apple.html | 200 +---------- output/v4/Apple.js.html | 59 +--- output/v4/Database.html | 268 ++------------- output/v4/Energy.html | 186 +---------- output/v4/Energy.js.html | 59 +--- output/v4/Environment.html | 186 +---------- output/v4/Environment.js.html | 59 +--- output/v4/HideConstructor.js.html | 59 +--- output/v4/Modules.js.html | 59 +--- output/v4/Statement.html | 301 +---------------- output/v4/StatementIterator.html | 289 +--------------- output/v4/Test.html | 176 +--------- output/v4/Tree.html | 200 +---------- output/v4/Tree.js.html | 59 +--- output/v4/World.html | 191 +---------- output/v4/World.js.html | 59 +--- output/v4/api.js.html | 59 +--- output/v4/global.html | 89 +---- output/v4/index.html | 479 ++------------------------- output/v4/module-SqlJs.html | 134 +------- output/v4/module-bookshelf.Book.html | 184 +--------- output/v4/module-bookshelf.html | 134 +------- output/v4/module-color_mixer.html | 134 +------- output/v4/tutorial-Alive_.html | 62 +--- output/v4/tutorial-Apple_.html | 62 +--- output/v4/tutorial-Environment_.html | 62 +--- output/v4/tutorial-Other.html | 62 +--- 29 files changed, 145 insertions(+), 3973 deletions(-) diff --git a/output/v4/Alive.html b/output/v4/Alive.html index 791029a6..31dc9ab6 100644 --- a/output/v4/Alive.html +++ b/output/v4/Alive.html @@ -1,184 +1,4 @@ - - - - - JSDoc: Class: Alive - - - - - - - - - - -
- -

Class: Alive

- - - - - - -
- - -
- - -

- - Alive - -

- - - -
- - -
-
- - - - - -

- new Alive() -

- - -

This is a short summary of the Alive class. These texts are just acting -as filler texts for summary.

- - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +Class: Alive
On this page

Alive

new Alive()

This is a short summary of the Alive class. These texts are just acting as filler texts for summary.

Source

Members

NUMBER_ARRAY :Object

This is a number array.

Type:
  • Object
Default Value
  • {"google":"Google","games":"Games"}
Source

energy

amount of energy

Properties
TypeDescription
Energy
Default Value
  • null
Source
Example
world = this.world
function test() {
 return world
}

Methods

gameQuery()

Text

Text

code
+

Note that commands are not matched in captions or in the middle of the text.

Source

survive(life) → {Energy}

Parameters:
NameTypeDescription
lifearray.<(object|function()|array|number|string|undefined|null|Symbol|boolean|Energy)>

This is an array of many things.

Deprecated
  • Yes
Source
Returns:

the energy wasted in this surviving instance

Type: 
Energy
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Alive.js.html b/output/v4/Alive.js.html index 087f3279..de97d34f 100644 --- a/output/v4/Alive.js.html +++ b/output/v4/Alive.js.html @@ -1,37 +1,6 @@ - - - - - JSDoc: Source: Alive.js - - - - - - - - - - -
- -

Source: Alive.js

- - - - - - -
-
-

- -

-
-
- 
/**
+    
On this page
Alive.js
/**
  * @summary
  * This is a short summary of the `Alive` class. These texts are just acting
  * as filler texts for summary.
@@ -90,26 +59,4 @@ 

     gameQuery() {
         return null;
     }
-}

-        

-    

-
-
-
-
-

-
-
-
-

-
-

-    Documentation generated by JSDoc 4.0.0 on Sun Dec 18 2022 20:24:53 GMT+0530 (India Standard Time)
-

-
-
-
-
-
+}
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Apple.html b/output/v4/Apple.html index 5e071bb5..bafb5ede 100644 --- a/output/v4/Apple.html +++ b/output/v4/Apple.html @@ -1,196 +1,4 @@ - - - - - JSDoc: Class: Apple - - - - - - - - - - -
- -

Class: Apple

- - - - - - -
- - -
- - -

- - Apple - -

- - -

Donec imperdiet dignissim semper. Sed vehicula purus dui, eget porta lectus convallis sagittis. Suspendisse ac lectus dignissim, tincidunt nisi quis, gravida metus.

- - -
- - -
-
- - - - -

Constructor

- - -

- new Apple() -

- - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- - -

Extends

- - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +Class: Apple
On this page

Apple

Donec imperdiet dignissim semper. Sed vehicula purus dui, eget porta lectus convallis sagittis. Suspendisse ac lectus dignissim, tincidunt nisi quis, gravida metus.

Constructor

new Apple()

Source

Extends

Members

NUMBER_ARRAY :Object

This is a number array.

Type:
  • Object
Overrides
Default Value
  • {"google":"Google","games":"Games"}
Source

color :String

Donec imperdiet dignissim

Type:
  • String
Source

energy

amount of energy

Properties
TypeDescription
Energy
Overrides
Default Value
  • null
Source
Example
world = this.world
function test() {
 return world
}

Methods

fib() → {number}

Generate the Fibonacci sequence of numbers.

Source
Yields:

The next number in the Fibonacci sequence.

Type: 
number

gameQuery()

Text

Text

code
+

Note that commands are not matched in captions or in the middle of the text.

Overrides
Source

survive(life) → {Energy}

Parameters:
NameTypeDescription
lifearray.<(object|function()|array|number|string|undefined|null|Symbol|boolean|Energy)>

This is an array of many things.

Overrides
Deprecated
  • Yes
Source
Returns:

the energy wasted in this surviving instance

Type: 
Energy

Events

beEaten

Sed vehicula purus dui

Type:
Source
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Apple.js.html b/output/v4/Apple.js.html index c30d824d..1dccc562 100644 --- a/output/v4/Apple.js.html +++ b/output/v4/Apple.js.html @@ -1,37 +1,6 @@ - - - - - JSDoc: Source: Apple.js - - - - - - - - - - -
- -

Source: Apple.js

- - - - - - -
-
-

- -

-
-
- 
/**
+    
On this page
Apple.js
/**
  * Donec imperdiet dignissim semper. Sed vehicula purus dui, eget porta lectus convallis sagittis. Suspendisse ac lectus dignissim, tincidunt nisi quis, gravida metus.
  * @class
  * @extends Alive
@@ -68,26 +37,4 @@ 

  *
  * @yields {number} The next number in the Fibonacci sequence.
  */
-function* fibonacci() { }

-        

-    

-
-
-
-
-

-
-
-
-

-
-

-    Documentation generated by JSDoc 4.0.0 on Sun Dec 18 2022 20:24:53 GMT+0530 (India Standard Time)
-

-
-
-
-
-
+function* fibonacci() { }
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Database.html b/output/v4/Database.html index 098c6746..34546ef7 100644 --- a/output/v4/Database.html +++ b/output/v4/Database.html @@ -1,239 +1,29 @@ - - - - - JSDoc: Class: Database - - - - - - - - - - -
- -

Class: Database

- - - - - - -
- - -
- - -

- - Database - -

- - -

Represents an SQLite database

- - -
- - -
-
- - - - -

Constructor

- - -

- new Database(data) -

- - - - - - - - - - - - - - -
- Parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
data - - - - Array.<number> - - - - -

An array of bytes representing -an SQLite database file

- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +Class: Database
On this page

Database

Represents an SQLite database

Constructor

new Database(data)

Parameters:
NameTypeDescription
dataArray.<number>

An array of bytes representing an SQLite database file

Source

Methods

["close"]()

Close the database, and all associated prepared statements. The memory associated to the database and all associated statements will be freed.

Warning: A statement belonging to a database that has been closed cannot be used anymore.

Databases must be closed when you're finished with them, or the memory consumption will grow forever

Source

["create_function"](name, func) → {Database}

Register a custom function with SQLite

Parameters:
NameTypeDescription
namestring

the name of the function as referenced in SQL statements.

funcfunction

the actual function to be executed.

Source
Returns:

The database object. Useful for method chaining

Type: 
Database
Example

Register a simple function

        db.create_function("addOne", function (x) {return x+1;})
+        db.exec("SELECT addOne(1)") // = 2
+

["each"](sql, paramsopt, callback, done) → {Database}

Execute a sql statement, and call a callback for each row of result. Currently, this method is synchronous, it will not return until the callback has been called on every row of the result. But this might change.

Parameters:
NameTypeAttributesDefaultDescription
sqlstring

A string of SQL text. Can contain placeholders that will be bound to the parameters given as the second argument

paramsStatement.BindParams<optional>
[]

Parameters to bind to the query

callbackfunction

Function to call on each row of result

donefunction

A function that will be called when all rows have been retrieved

Source
Returns:

The database object. Useful for method chaining

Type: 
Database
Example

Read values from a table

    db.each("SELECT name,age FROM users WHERE age >= $majority", {$majority:18},
+            function (row){console.log(row.name + " is a grown-up.")}
+    );

["exec"](sql, paramsopt) → {Array.<Database.QueryExecResult>}

Execute an SQL query, and returns the result.

This is a wrapper against Database.prepare, Statement.bind, Statement.step, Statement.get, and Statement.free.

The result is an array of result elements. There are as many result elements as the number of statements in your sql string (statements are separated by a semicolon)

Example use

We will create the following table, named test and query it with a multi-line statement using params:

idagename
11Ling
218Paul

We query it like that:

var db = new SQL.Database();
+var res = db.exec(
+    "DROP TABLE IF EXISTS test;\n"
+    + "CREATE TABLE test (id INTEGER, age INTEGER, name TEXT);"
+    + "INSERT INTO test VALUES ($id1, :age1, @name1);"
+    + "INSERT INTO test VALUES ($id2, :age2, @name2);"
+    + "SELECT id FROM test;"
+    + "SELECT age,name FROM test WHERE id=$id1",
+    {
+        "$id1": 1, ":age1": 1, "@name1": "Ling",
+        "$id2": 2, ":age2": 18, "@name2": "Paul"
+    }
+);
+

res is now :

    [
+        {"columns":["id"],"values":[[1],[2]]},
+        {"columns":["age","name"],"values":[[1,"Ling"]]}
+    ]
+
Parameters:
NameTypeAttributesDescription
sqlstring

a string containing some SQL text to execute

paramsStatement.BindParams<optional>

When the SQL statement contains placeholders, you can pass them in here. They will be bound to the statement before it is executed. If you use the params argument as an array, you cannot provide an sql string that contains several statements (separated by ;). This limitation does not apply to params as an object.

Source
Returns:

The results of each statement

Type: 
Array.<Database.QueryExecResult>

["export"]() → {Uint8Array}

Exports the contents of the database to a binary array

Source
Returns:

An array of bytes of the SQLite3 database file

Type: 
Uint8Array

["getRowsModified"]() → {number}

Returns the number of changed rows (modified, inserted or deleted) by the latest completed INSERT, UPDATE or DELETE statement on the database. Executing any other type of SQL statement does not modify the value returned by this function.

Source
Returns:

the number of rows modified

Type: 
number

["handleError"]()

Analyze a result code, return null if no error occurred, and throw an error with a descriptive message otherwise

Source

["iterateStatements"](sql) → {StatementIterator}

Iterate over multiple SQL statements in a SQL string. This function returns an iterator over Statement objects. You can use a for...of loop to execute the returned statements one by one.

Parameters:
NameTypeDescription
sqlstring

a string of SQL that can contain multiple statements

Source
Returns:

the resulting statement iterator

Type: 
StatementIterator
Example

Get the results of multiple SQL queries

const sql_queries = "SELECT 1 AS x; SELECT '2' as y";
for (const statement of db.iterateStatements(sql_queries)) {
    const sql = statement.getSQL(); // Get the SQL source
    const result = statement.getAsObject({}); // Get the row of data
    console.log(sql, result);
}
// This will print:
// 'SELECT 1 AS x;' { x: 1 }
// " SELECT '2' as y" { y: '2' }

["prepare"](sql, paramsopt) → {Statement}

Prepare an SQL statement

Parameters:
NameTypeAttributesDescription
sqlstring

a string of SQL, that can contain placeholders (?, :VVV, :AAA, @AAA)

paramsStatement.BindParams<optional>

values to bind to placeholders

Source
Throws:

SQLite error

Type
String
Returns:

the resulting statement

Type: 
Statement

["run"](sql, paramsopt) → {Database}

Execute an SQL query, ignoring the rows it returns.

Parameters:
NameTypeAttributesDescription
sqlstring

a string containing some SQL text to execute

paramsStatement.BindParams<optional>

When the SQL statement contains placeholders, you can pass them in here. They will be bound to the statement before it is executed. If you use the params argument, you cannot provide an sql string that contains several statements (separated by ;)

Source
Returns:

The database object (useful for method chaining)

Type: 
Database
Example
// Insert values in a table
+    db.run(
+        "INSERT INTO test VALUES (:age, :name)",
+        { ':age' : 18, ':name' : 'John' }
+    );
+

Type Definitions

QueryExecResult

Type:
  • Object
Properties
NameTypeDescription
columnsArray.<string>

the name of the columns of the result (as returned by Statement.getColumnNames)

valuesArray.<Array.<Database.SqlValue>>

one array per row, containing the column values

Source

SqlValue

Type:
  • string | number | null | Uint8Array
Source
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Energy.html b/output/v4/Energy.html index de8c1896..0017b0d2 100644 --- a/output/v4/Energy.html +++ b/output/v4/Energy.html @@ -1,185 +1,3 @@ - - - - - JSDoc: Class: Energy - - - - - - - - - - -
- -

Class: Energy

- - - - - - -
- - -
- - -

- - Energy - -

- - -

An unit of energy . Curabitur sollicitudin porttitor turpis vitae rutrum. Mauris interdum neque id massa sollicitudin, fermentum facilisis erat commodo. In at purus a risus aliquam faucibus.

- - -
- - -
-
- - - - -

Constructor

- - -

- new Energy() -

- - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +
On this page

Energy

An unit of energy . Curabitur sollicitudin porttitor turpis vitae rutrum. Mauris interdum neque id massa sollicitudin, fermentum facilisis erat commodo. In at purus a risus aliquam faucibus.

clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Energy.js.html b/output/v4/Energy.js.html index 28d83bc2..eb375e4d 100644 --- a/output/v4/Energy.js.html +++ b/output/v4/Energy.js.html @@ -1,37 +1,6 @@ - - - - - JSDoc: Source: Energy.js - - - - - - - - - - -
- -

Source: Energy.js

- - - - - - -
-
-

- -

-
-
- 
/**
+    
On this page
Energy.js
/**
  * An unit of energy . Curabitur sollicitudin porttitor turpis vitae rutrum. Mauris interdum neque id massa sollicitudin, fermentum facilisis erat commodo. In at purus a risus aliquam faucibus.
  * @class
  */
@@ -56,26 +25,4 @@ 

  * @property {String} foo kajsdh kajhsd
  * @property {Array<Array<String>>} hello aksjdh kaj shdkj asd
  */
-

-        

-    

-
-
-
-
-

-
-
-
-

-
-

-    Documentation generated by JSDoc 4.0.0 on Sun Dec 18 2022 20:24:53 GMT+0530 (India Standard Time)
-

-
-
-
-
-
+
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Environment.html b/output/v4/Environment.html index 85000efc..f3b90612 100644 --- a/output/v4/Environment.html +++ b/output/v4/Environment.html @@ -1,185 +1,3 @@ - - - - - JSDoc: Class: Environment - - - - - - - - - - -
- -

Class: Environment

- - - - - - -
- - -
- - -

- - Environment - -

- - -

Lorem ipsum dolor sit amet, Energy consectetur adipiscing elit. Vestibulum condimentum tempus diam. Ut eget ultricies metus, vitae ornare turpis. Vivamus lectus metus, euismod quis tortor quis, pretium semper massa. Nulla mauris sapien, faucibus vitae metus et, ultrices fringilla sem. Sed laoreet tempor odio, elementum scelerisque nunc aliquet quis.

- - -
- - -
-
- - - - -

Constructor

- - -

- new Environment() -

- - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +
On this page

Environment

Lorem ipsum dolor sit amet, Energy consectetur adipiscing elit. Vestibulum condimentum tempus diam. Ut eget ultricies metus, vitae ornare turpis. Vivamus lectus metus, euismod quis tortor quis, pretium semper massa. Nulla mauris sapien, faucibus vitae metus et, ultrices fringilla sem. Sed laoreet tempor odio, elementum scelerisque nunc aliquet quis.

Constructor

new Environment()

Source

Members

livingThings :Array.<Alive>

All the living things in this environment

Type:
Source

name :String

The name of this environment

Type:
  • String
Source

Methods

start(config)

Vestibulum condimentum tempus Alive diam.

Parameters:
NameTypeDescription
configEnvironmentConfiguration
Source

Events

beforeDestroy

Lorem ipsum dolor sit amet, Energy consectetur adipiscing el

Type:
Properties
NameTypeDescription
fooboolean

aalks djlas

Source
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Environment.js.html b/output/v4/Environment.js.html index 29536c88..93f99918 100644 --- a/output/v4/Environment.js.html +++ b/output/v4/Environment.js.html @@ -1,37 +1,6 @@ - - - - - JSDoc: Source: Environment.js - - - - - - - - - - -
- -

Source: Environment.js

- - - - - - -
-
-

- -

-
-
- 
/**
+    
On this page
Environment.js
/**
  * Lorem ipsum dolor sit amet, {@link Energy} consectetur adipiscing elit. Vestibulum condimentum tempus diam. Ut eget ultricies metus, vitae ornare turpis. Vivamus lectus metus, euismod quis tortor quis, pretium semper massa. Nulla mauris sapien, faucibus vitae metus et, ultrices fringilla sem. Sed laoreet tempor odio, elementum scelerisque nunc aliquet quis.
  *
  * @class
@@ -72,26 +41,4 @@ 

  * @type {Energy}
  * @property {boolean} foo aalks djlas
  */
-

-        

-    

-
-
-
-
-

-
-
-
-

-
-

-    Documentation generated by JSDoc 4.0.0 on Sun Dec 18 2022 20:24:53 GMT+0530 (India Standard Time)
-

-
-
-
-
-
+
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/HideConstructor.js.html b/output/v4/HideConstructor.js.html index fd7ab3c9..d1dc1468 100644 --- a/output/v4/HideConstructor.js.html +++ b/output/v4/HideConstructor.js.html @@ -1,37 +1,6 @@ - - - - - JSDoc: Source: HideConstructor.js - - - - - - - - - - -
- -

Source: HideConstructor.js

- - - - - - -
-
-

- -

-
-
- 
/**
+    
On this page
HideConstructor.js
/**
  * Constructor should be hidden
  * @hideconstructor
  */
@@ -47,26 +16,4 @@ 

     start(config) {
 
     }
-}

-        

-    

-
-
-
-
-

-
-
-
-

-
-

-    Documentation generated by JSDoc 4.0.0 on Sun Dec 18 2022 20:24:53 GMT+0530 (India Standard Time)
-

-
-
-
-
-
+}
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Modules.js.html b/output/v4/Modules.js.html index 495b0e12..bc854aa8 100644 --- a/output/v4/Modules.js.html +++ b/output/v4/Modules.js.html @@ -1,37 +1,6 @@ - - - - - JSDoc: Source: Modules.js - - - - - - - - - - -
- -

Source: Modules.js

- - - - - - -
-
-

- -

-
-
- 
/** @module color/mixer */
+    
On this page
Modules.js
/** @module color/mixer */
 module.exports = {
     /** Blend two `colours` together. */
     blend: function (color1, color2) { },
@@ -49,26 +18,4 @@ 

 this.Book = function (title) {
     /** The title. */
     this.title = title;
-};

-        

-    

-
-
-
-
-

-
-
-
-

-
-

-    Documentation generated by JSDoc 4.0.0 on Sun Dec 18 2022 20:24:53 GMT+0530 (India Standard Time)
-

-
-
-
-
-
+};
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Statement.html b/output/v4/Statement.html index 8161d23b..620969d9 100644 --- a/output/v4/Statement.html +++ b/output/v4/Statement.html @@ -1,284 +1,17 @@ - - - - - JSDoc: Class: Statement - - - - - - - - - - -
- -

Class: Statement

- - - - - - -
- - -
- - -

- - SqlJs - - Statement - -

- - -

Represents a prepared statement. -Prepared statements allow you to have a template sql string, -that you can execute multiple times with different parameters.

-

You can't instantiate this class directly, you have to use a -Database object in order to create a statement.

-

Warning: When you close a database (using db.close()), -all its statements are closed too and become unusable.

-

Statements can't be created by the API user directly, only by -Database::prepare

- - -
- - -
-
- - - - -

Constructor

- - -

- new Statement(stmt1, db) -

- - - - - - - - - - - - - - -
- Parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
stmt1 - - - - number - - - - -

The SQLite statement reference

db - - - - Database - - - - -

The database from which this statement was created

- -
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - -
-
See
-
- -
-
- - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +Class: Statement
On this page

SqlJs Statement

Represents a prepared statement. Prepared statements allow you to have a template sql string, that you can execute multiple times with different parameters.

You can't instantiate this class directly, you have to use a Database object in order to create a statement.

Warning: When you close a database (using db.close()), all its statements are closed too and become unusable.

Statements can't be created by the API user directly, only by Database::prepare

Constructor

new Statement(stmt1, db)

Parameters:
NameTypeDescription
stmt1number

The SQLite statement reference

dbDatabase

The database from which this statement was created

Source
See

Methods

["bind"](values) → {boolean}

Bind values to the parameters, after having reset the statement. If values is null, do nothing and return true.

SQL statements can have parameters, named '?', '?NNN', ':VVV', '@VVV', '$VVV', where NNN is a number and VVV a string. This function binds these parameters to the given values.

Warning: ':', '@', and '$' are included in the parameters names

Value types

Javascript typeSQLite type
numberREAL, INTEGER
booleanINTEGER
stringTEXT
Array, Uint8ArrayBLOB
nullNULL
Parameters:
NameTypeDescription
valuesStatement.BindParams

The values to bind

Source
See
Throws:

SQLite Error

Type
String
Returns:

true if it worked

Type: 
boolean
Examples

Bind values to named parameters

    var stmt = db.prepare(
        "UPDATE test SET a=@newval WHERE id BETWEEN $mini AND $maxi"
    );
    stmt.bind({$mini:10, $maxi:20, '@newval':5});

Bind values to anonymous parameters

// Create a statement that contains parameters like '?', '?NNN'
var stmt = db.prepare("UPDATE test SET a=? WHERE id BETWEEN ? AND ?");
// Call Statement.bind with an array as parameter
stmt.bind([5, 10, 20]);

["free"]() → {boolean}

Free the memory used by the statement

Source
Returns:

true in case of success

Type: 
boolean

["freemem"]()

Free the memory allocated during parameter binding

Source

["get"](paramsopt) → {Array.<Database.SqlValue>}

Get one row of results of a statement. If the first parameter is not provided, step must have been called before.

Parameters:
NameTypeAttributesDescription
paramsStatement.BindParams<optional>

If set, the values will be bound to the statement before it is executed

Source
Returns:

One row of result

Type: 
Array.<Database.SqlValue>
Example

Print all the rows of the table test to the console

    var stmt = db.prepare("SELECT * FROM test");
+    while (stmt.step()) console.log(stmt.get());

["getAsObject"](paramsopt) → {Object.<string, Database.SqlValue>}

Get one row of result as a javascript object, associating column names with their value in the current row.

Parameters:
NameTypeAttributesDescription
paramsStatement.BindParams<optional>

If set, the values will be bound to the statement, and it will be executed

Source
See
  • Statement.get
Returns:

The row of result

Type: 
Object.<string, Database.SqlValue>
Example
var stmt = db.prepare(
+            "SELECT 5 AS nbr, x'010203' AS data, NULL AS null_value;"
+        );
+        stmt.step(); // Execute the statement
+        console.log(stmt.getAsObject());
+        // Will print {nbr:5, data: Uint8Array([1,2,3]), null_value:null}

["getColumnNames"]() → {Array.<string>}

Get the list of column names of a row of result of a statement.

Source
Returns:

The names of the columns

Type: 
Array.<string>
Example
var stmt = db.prepare(
+        "SELECT 5 AS nbr, x'616200' AS data, NULL AS null_value;"
+    );
+    stmt.step(); // Execute the statement
+    console.log(stmt.getColumnNames());
+    // Will print ['nbr','data','null_value']

["getNormalizedSQL"]() → {string}

Get the SQLite's normalized version of the SQL string used in preparing this statement. The meaning of "normalized" is not well-defined: see the SQLite documentation.

Source
Returns:

The normalized SQL string

Type: 
string
Example
db.run("create table test (x integer);");
+     stmt = db.prepare("select * from test where x = 42");
+     // returns "SELECT*FROM test WHERE x=?;"
+

["getSQL"]() → {string}

Get the SQL string used in preparing this statement.

Source
Returns:

The SQL string

Type: 
string

["reset"]()

Reset a statement, so that it's parameters can be bound to new values It also clears all previous bindings, freeing the memory used by bound parameters.

Source

["run"](valuesopt)

Shorthand for bind + step + reset Bind the values, execute the statement, ignoring the rows it returns, and resets it

Parameters:
NameTypeAttributesDescription
valuesStatement.BindParams<optional>

Value to bind to the statement

Source

["step"]() → {boolean}

Execute the statement, fetching the next line of result, that can be retrieved with Statement.get.

Source
Throws:

SQLite Error

Type
String
Returns:

true if a row of result available

Type: 
boolean

Type Definitions

BindParams

Type:
Source
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/StatementIterator.html b/output/v4/StatementIterator.html index 5322ad57..dbc85957 100644 --- a/output/v4/StatementIterator.html +++ b/output/v4/StatementIterator.html @@ -1,288 +1,3 @@ - - - - - JSDoc: Class: StatementIterator - - - - - - - - - - -
- -

Class: StatementIterator

- - - - - - -
- - -
- - -

- - SqlJs - - StatementIterator - -

- - -

An iterator over multiple SQL statements in a string, -preparing and returning a Statement object for the next SQL -statement on each iteration.

-

You can't instantiate this class directly, you have to use a -Database object in order to create a statement iterator

-

{@see Database#iterateStatements}

- - -
- - -
-
- - - - -

Constructor

- - -

- new StatementIterator(sql, db) -

- - - - - - - - - - - - - - -
- Parameters: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameTypeDescription
sql - - - - string - - - - -

A string containing multiple SQL statements

db - - - - Database - - - - -

The database from which this iterator was created

- -
- - - - - - - -
- - - - - - - - - - - - -
-
Implements
-
-
- - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - -
- Example - - 
// loop over and execute statements in string sql
for (let statement of db.iterateStatements(sql)) {
    statement.step();
    // get results, etc.
    // do not call statement.free() manually, each statement is freed
    // before the next one is parsed
}

// capture any bad query exceptions with feedback
// on the bad sql
let it = db.iterateStatements(sql);
try {
    for (let statement of it) {
        statement.step();
    }
} catch(e) {
    console.log(
        `The SQL string "${it.getRemainingSQL()}" ` +
        `contains the following error: ${e}`
    );
}
- -
- - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +
On this page

SqlJs StatementIterator

An iterator over multiple SQL statements in a string, preparing and returning a Statement object for the next SQL statement on each iteration.

You can't instantiate this class directly, you have to use a Database object in order to create a statement iterator

{@see Database#iterateStatements}

Constructor

new StatementIterator(sql, db)

Parameters:
NameTypeDescription
sqlstring

A string containing multiple SQL statements

dbDatabase

The database from which this iterator was created

Implements
Source
Example
// loop over and execute statements in string sql
for (let statement of db.iterateStatements(sql)) {
    statement.step();
    // get results, etc.
    // do not call statement.free() manually, each statement is freed
    // before the next one is parsed
}

// capture any bad query exceptions with feedback
// on the bad sql
let it = db.iterateStatements(sql);
try {
    for (let statement of it) {
        statement.step();
    }
} catch(e) {
    console.log(
        `The SQL string "${it.getRemainingSQL()}" ` +
        `contains the following error: ${e}`
    );
}

Methods

["getRemainingSQL"]() → {String}

Get any un-executed portions remaining of the original SQL string

Source
Returns:
Type: 
String

["next"]() → {StatementIterator.StatementIteratorResult}

Prepare the next available SQL statement

Source
Throws:

SQLite error or invalid iterator error

Type
String
Returns:
Type: 
StatementIterator.StatementIteratorResult

Type Definitions

StatementIteratorResult

Type:
  • Object | Object
Properties
NameTypeDescription
valueStatement

the next available Statement (as returned by Database.prepare)

doneboolean

true if there are no more available statements

Source
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Test.html b/output/v4/Test.html index 52f680fc..b2b53003 100644 --- a/output/v4/Test.html +++ b/output/v4/Test.html @@ -1,175 +1,3 @@ - - - - - JSDoc: Class: Test - - - - - - - - - - -
- -

Class: Test

- - - - - - -
- - -
- - -

- - Test - -

- - -

Constructor should be hidden

- - -
- - -
-
- - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +
On this page

Test

Constructor should be hidden

clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Tree.html b/output/v4/Tree.html index d808c481..e4126736 100644 --- a/output/v4/Tree.html +++ b/output/v4/Tree.html @@ -1,196 +1,4 @@ - - - - - JSDoc: Class: Tree - - - - - - - - - - -
- -

Class: Tree

- - - - - - -
- - -
- - -

- - Tree - -

- - -

Donec imperdiet dignissim semper. Sed vehicula purus dui, eget porta lectus convallis sagittis. Suspendisse ac lectus dignissim, tincidunt nisi quis, gravida metus.

- - -
- - -
-
- - - - -

Constructor

- - -

- new Tree() -

- - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- - -

Extends

- - - - - - - - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +Class: Tree
On this page

Tree

Donec imperdiet dignissim semper. Sed vehicula purus dui, eget porta lectus convallis sagittis. Suspendisse ac lectus dignissim, tincidunt nisi quis, gravida metus.

Constructor

new Tree()

Source

Extends

Members

NUMBER_ARRAY :Object

This is a number array.

Type:
  • Object
Overrides
Default Value
  • {"google":"Google","games":"Games"}
Source

branches :Array.<Alive>

Donec imperdiet dignissim

Type:
Source

energy

amount of energy

Properties
TypeDescription
Energy
Overrides
Default Value
  • null
Source
Example
world = this.world
function test() {
 return world
}

Methods

crop(environment) → {Energy}

Parameters:
NameTypeDescription
environmentEnvironment

the environment when this Alive thing is surviving

Source
Fires:
  • Tree.event:crop
Throws:

Err

Returns:

the energy wasted in this surviving instance

Type: 
Energy

gameQuery()

Text

Text

code
+

Note that commands are not matched in captions or in the middle of the text.

Overrides
Source

survive(life) → {Energy}

Parameters:
NameTypeDescription
lifearray.<(object|function()|array|number|string|undefined|null|Symbol|boolean|Energy)>

This is an array of many things.

Overrides
Deprecated
  • Yes
Source
Returns:

the energy wasted in this surviving instance

Type: 
Energy
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Tree.js.html b/output/v4/Tree.js.html index b11a9435..52ff7869 100644 --- a/output/v4/Tree.js.html +++ b/output/v4/Tree.js.html @@ -1,37 +1,6 @@ - - - - - JSDoc: Source: Tree.js - - - - - - - - - - -
- -

Source: Tree.js

- - - - - - -
-
-

- -

-
-
- 
/**
+    
On this page
Tree.js
/**
  * Donec imperdiet dignissim semper. Sed vehicula purus dui, eget porta lectus convallis sagittis. Suspendisse ac lectus dignissim, tincidunt nisi quis, gravida metus.
  * @class
  * @extends Alive
@@ -56,26 +25,4 @@ 

         return null;
     }
 }
-

-        

-    

-
-
-
-
-

-
-
-
-

-
-

-    Documentation generated by JSDoc 4.0.0 on Sun Dec 18 2022 20:24:53 GMT+0530 (India Standard Time)
-

-
-
-
-
-
+
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/World.html b/output/v4/World.html index ee230eea..9b336e1f 100644 --- a/output/v4/World.html +++ b/output/v4/World.html @@ -1,46 +1,6 @@ - - - - - JSDoc: Class: World - - - - - - - - - - -
- -

Class: World

- - - - - - -
- - -
- - -

- - World - -

- - -

Class World defines the coordinate system for the model. -It has transforms for multiple coordinate systems.

-

The world is defined by an object with 6 properties:

-
     WorldOptions = {
+    
On this page
World
Class World defines the coordinate system for the model. It has transforms for multiple coordinate systems.
The world is defined by an object with 6 properties:
     WorldOptions = {
          minX: integer,
          maxX: integer,
          minY: integer,
@@ -48,149 +8,4 @@ 

          minZ: integer,
          maxZ: integer,
      }
-

-        
-    
-

-
-
-

-    

-    
-        
-
-    
-        
Constructor

-    
-
-    

-        new World()
-    

-
-    
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-
-    
-        

-            
Source

-            

-        

-    
-
-    
-
-    
-
-    
-

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-    
-    

-
-    
-
-    
-
-    
-
-     
-
-    
-
-    
-
-    
-
-    
-
-    
-

-
-

-
-
-
-
-

-
-
-
-

-
-

-    Documentation generated by JSDoc 4.0.0 on Sun Dec 18 2022 20:24:53 GMT+0530 (India Standard Time)
-

-
-
-
-
-
\ No newline at end of file
+

Constructor

new World()

Source

Methods

defaultOptions(maxXopt, maxYopt, maxZopt)

Return a default options object, origin at center.

Parameters:
NameTypeAttributesDefaultDescription
maxXnumber<optional>
16

Integer max X value

maxYnumber<optional>
maxX

Integer max Y value

maxZnumber<optional>
Math.max(maxX, maxY)

Integer max Z value

Source
Returns:

WorldOptions

clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/World.js.html b/output/v4/World.js.html index 9d58a56d..6dc12076 100644 --- a/output/v4/World.js.html +++ b/output/v4/World.js.html @@ -1,37 +1,6 @@ - - - - - JSDoc: Source: World.js - - - - - - - - - - -
- -

Source: World.js

- - - - - - -
-
-

- -

-
-
- 
import * as util from './utils.js'
+    
On this page
World.js
import * as util from './utils.js'
 
 // class World defines the coordinate system for the model.
 // It will be  upgraded with methods converting from other
@@ -95,26 +64,4 @@ 

         }
     }
 }
-

-        

-    

-
-
-
-
-

-
-
-
-

-
-

-    Documentation generated by JSDoc 4.0.0 on Sun Dec 18 2022 20:24:53 GMT+0530 (India Standard Time)
-

-
-
-
-
-
+
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/api.js.html b/output/v4/api.js.html index 9dbc744d..dbd4abf9 100644 --- a/output/v4/api.js.html +++ b/output/v4/api.js.html @@ -1,37 +1,6 @@ - - - - - JSDoc: Source: api.js - - - - - - - - - - -
- -

Source: api.js

- - - - - - -
-
-

- -

-
-
- 
/* global
+    
On this page
api.js
/* global
     ALLOC_NORMAL
     FS
     HEAP8
@@ -1164,26 +1133,4 @@ 

     };
     // export Database to Module
     Module.Database = Database;
-};

-        

-    

-
-
-
-
-

-
-
-
-

-
-

-    Documentation generated by JSDoc 4.0.0 on Sun Dec 18 2022 20:24:53 GMT+0530 (India Standard Time)
-

-
-
-
-
-
+};
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/global.html b/output/v4/global.html index 0a2be717..ce633c97 100644 --- a/output/v4/global.html +++ b/output/v4/global.html @@ -1,86 +1,3 @@ - - - - - JSDoc: Global - - - - - - - - - - -
- -

Global

- - - - - - -
- - - -
-
- - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +Global
On this page

Methods

fibonacci() → {number}

Generate the Fibonacci sequence of numbers.

Source
Yields:

The next number in the Fibonacci sequence.

Type: 
number

initSqlJs(config) → {SqlJs}

Asynchronously initializes sql.js

Parameters:
NameTypeDescription
configSqlJsConfig

module initialization parameters

Source
Returns:
Type: 
SqlJs
Example
initSqlJs({
 locateFile: name => '/path/to/assets/' + name
}).then(SQL => {
 const db = new SQL.Database();
 const result = db.exec("select 'hello world'");
 console.log(result);
})

Type Definitions

EnergyUnit

Type:
  • Object
Properties
NameTypeDescription
fooString

kajsdh kajhsd

helloArray.<Array.<String>>

aksjdh kaj shdkj asd

Source

EnvironmentConfiguration

Type:
  • Object
Properties
NameTypeDescription
nameString
strangeMap.<String, Number>
Source

SqlJs

Type:
  • Object
Properties
NameTypeDescription
DatabaseDatabase

A class that represents an SQLite database

StatementStatement

The prepared statement class

Source

SqlJsConfig

Type:
  • Object
Properties
NameTypeDescription
locateFilefunction

a function that returns the full path to a resource given its file name

Source
See
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/index.html b/output/v4/index.html index 8b313d86..09ce2710 100644 --- a/output/v4/index.html +++ b/output/v4/index.html @@ -1,111 +1,16 @@ - - - - - JSDoc: Home - - - - - - - - - - -
- -

Home

- - - - - - - - - - - - - - - - - - -
-

clean-jsdoc-theme

-

Stars Fork Version Issues Open Contributors Build Status license -

-

clean-jsdoc-theme is a beautifully crafted theme for JSDoc 3. It is a clean and fully responsive theme with loads of -customisation features.

-

Some salient features:

-
    -
  1. It supports most screens, i.e. desktops, laptops, iPad and mobile devices.
    2. -
  2. It has a premium-looking dark and light theme.
    3. -
  3. It minifies all the output HTML files (this helps in saving a few KBs).
    4. -
  4. It has search support. The search feature doesn't increase the size of output HTML files.
    5. -
  5. It is regularly updated.
    6. -
  6. It is highly -performant. Check lighthouse report here -.
    7. -
-

We know that no library is perfect. That's why we are open to hearing from the community about the theme. For any -suggestions, questions or bugs, feel free to create -an issue.

-

Demo

-
    -
  1. -

    To view this theme, visit https://ankdev.me/clean-jsdoc-theme/v4.

    -
    2. -
  2. -

    If you want to see a demo repo to set up this theme, -visit clean-jsdoc-theme-example. This repo will guide -you step by step on how to set up JSDoc and clean-jsdoc-theme in your existing repo.

    -
    3. -
-

Screenshots

-

Dark theme -Light theme -Mobile View -Search view -Class page -Code page

-

Installation

-
-

Note : you must have node and npm installed on your machine.

-
-

In a terminal, type :

-
npm install clean-jsdoc-theme --save-dev
+    
On this page
clean-jsdoc-theme
StarsForkVersion Issues OpenContributorsBuild Statuslicense
clean-jsdoc-theme is a beautifully crafted theme for JSDoc 3. It is a clean and fully responsive theme with loads of customisation features.
Some salient features:
  1. It supports most screens, i.e. desktops, laptops, iPad and mobile devices.
  2. It has a premium-looking dark and light theme.
  3. It minifies all the output HTML files (this helps in saving a few KBs).
  4. It has search support. The search feature doesn't increase the size of output HTML files.
  5. It is regularly updated.
  6. It is highly performant. Check lighthouse report here .
We know that no library is perfect. That's why we are open to hearing from the community about the theme. For any suggestions, questions or bugs, feel free to create an issue.
Demo
  1. To view this theme, visit https://ankdev.me/clean-jsdoc-theme/v4.
  2. If you want to see a demo repo to set up this theme, visit clean-jsdoc-theme-example. This repo will guide you step by step on how to set up JSDoc and clean-jsdoc-theme in your existing repo.
Screenshots
Dark theme Light theme Mobile View Search view Class page Code page
Installation
Note : you must have node and npm installed on your machine.
In a terminal, type :
npm install clean-jsdoc-theme --save-dev
 # or
 yarn add clean-jsdoc-theme -D
-

-
In your projects package.json file, add a script to generate the documentation using JSDoc :

-
"scripts": {
+
In your projects package.json file, add a script to generate the documentation using JSDoc :
"scripts": {
   "generate-docs": "jsdoc --configure jsdoc.json --verbose"
 }
-

-

-
Heads Up! In the above generate_docs script, the value of the --configure option is jsdoc.json. Make sure
-the jsdoc.json file exists as it contains the JSDoc configuration. If you have your JSDoc config in a different
-file,
-replace jsdoc.json with its name.

-

-
In your jsdoc.json file, add a template option to use clean-jsdoc-theme instead of the default JSDoc theme:

-
"opts": {
+
Heads Up! In the above generate_docs script, the value of the --configure option is jsdoc.json. Make sure the jsdoc.json file exists as it contains the JSDoc configuration. If you have your JSDoc config in a different file, replace jsdoc.json with its name.
In your jsdoc.json file, add a template option to use clean-jsdoc-theme instead of the default JSDoc theme:
"opts": {
   "template": "node_modules/clean-jsdoc-theme"
 }
-

-
Now, run the previously added script to generate the documentation :

-
npm run generate-docs
-

-
For more information, look at the clean-jsdoc-theme-example
-repository.

-
Example JSDoc Config

-
{
+
Now, run the previously added script to generate the documentation :
npm run generate-docs
+
For more information, look at the clean-jsdoc-theme-example repository.
Example JSDoc Config
{
     "source": {
         "include": ["lib", "package.json", "README.md"],
         "includePattern": ".js$",
@@ -129,53 +34,24 @@ 
Example JSDoc Config

         // This is important for clean-jsdoc-theme, otherwise some features might not work.
     }
 }
-

-
Options

-
Set a default theme

-
To set the default theme, add the following in your JSDoc config file:

-
"theme_opts": {
+
Options
Set a default theme
To set the default theme, add the following in your JSDoc config file:
"theme_opts": {
   "default_theme": "dark" // or "light"
 }
-

-
Set base url

-
To set the base url, add the following in your JSDoc config file:

-
"theme_opts": {
+
Set base url
To set the base url, add the following in your JSDoc config file:
"theme_opts": {
   "base_url": "https://ankdev.me/v4/"
 }
-

-

-
Make sure to add a forward slash (/) at the end of the URL.

-

-
The default value of base_url is computed with the following code:

-
const path = document.location.pathname;
+
Make sure to add a forward slash (/) at the end of the URL.
The default value of base_url is computed with the following code:
const path = document.location.pathname;
 const baseURL = path.substr(0, path.lastIndexOf('/') + 1);
-

-
Add favicon

-
To set a favicon, add the following in your JSDoc config file:

-
"theme_opts": {
+
Add favicon
To set a favicon, add the following in your JSDoc config file:
"theme_opts": {
   "favicon": "path/to/img"
 }
-

-
You can use static_dir option to copy all you static files to output dir and use that path instead
-of path/to/img.

-
Add homepage title

-
To add the title of the homepage use the homepageTitle property as follows:

-
"theme_opts": {
+
You can use static_dir option to copy all you static files to output dir and use that path instead of path/to/img.
Add homepage title
To add the title of the homepage use the homepageTitle property as follows:
"theme_opts": {
   "homepageTitle": "Clean JSDoc theme"
 }
-

-
Add title

-
Both strings and HTML are accepted. Use HTML to overwrite the default HTML, and a string to set a plaintext title. One
-example of this is below:

-
"theme_opts": {
+
Add title
Both strings and HTML are accepted. Use HTML to overwrite the default HTML, and a string to set a plaintext title. One example of this is below:
"theme_opts": {
   "title": "<img src='path/to/img' class='my-custom-class'/>" // or "title": "clean-jsodc-theme"
 }
-

-
You can use static_dir option to copy all you static files to output dir and use that path in place
-of path/to/img.

-
Add navbar menu

-
To render extra link(s) in navbar. It accepts an array of objects:

-
"theme_opts": {
+
You can use static_dir option to copy all you static files to output dir and use that path in place of path/to/img.
Add navbar menu
To render extra link(s) in navbar. It accepts an array of objects:
"theme_opts": {
   "menu": [
     {
       "title": "Website",
@@ -189,54 +65,10 @@ 
Add navbar menu

     }
   ]
 }
-

-
menu is an array of objects. Each object has five properties, out of which two are required (title and link). If
-an object doesn't have the required properties, then you might expect an error.

-
Properties

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
nametyperequired
titlestringrequired
linkstringrequired
targetstringoptional
classstringoptional
idstringoptional

-
Sections

-
There is also an option to add a meta tag to every generated HTML file. You can use the meta option to include a list
-of meta tags into head.

-
"theme_opts": {
+
menu is an array of objects. Each object has five properties, out of which two are required (title and link). If an object doesn't have the required properties, then you might expect an error.
Properties
nametyperequired
titlestringrequired
linkstringrequired
targetstringoptional
classstringoptional
idstringoptional
Sections
There is also an option to add a meta tag to every generated HTML file. You can use the meta option to include a list of meta tags into head.
"theme_opts": {
   "sections": ["Classes", "Modules", "Global"] // Only three members will be in the sidebar.
 }
-

-
// SECTION_TYPE
+
// SECTION_TYPE
 [
     'Classes',
     'Modules',
@@ -248,11 +80,7 @@ 
Sections

     'Interfaces',
     'Global'
 ];
-

-
Meta

-
There is also an option to add meta tag to every generated HTML file. You can use meta option to include a list
-of meta tags into head.

-
"theme_opts": {
+
Meta
There is also an option to add meta tag to every generated HTML file. You can use meta option to include a list of meta tags into head.
"theme_opts": {
   "meta": [
     {
       "name": "author",
@@ -264,28 +92,10 @@ 
Meta

     }
   ]
 }
-

-
meta is an array of objects. Each objects can have any valid combination
-of HTML metadata attributes.

-
-
By default, the search feature is enabled in the theme.

-

-
Make sure you have added the base_url option as well, otherwise your search query might fail.

-
If you want to disable the search feature, you can do the following:

-

-
"theme_opts": {
+
meta is an array of objects. Each objects can have any valid combination of HTML metadata attributes.
By default, the search feature is enabled in the theme.
Make sure you have added the base_url option as well, otherwise your search query might fail.
If you want to disable the search feature, you can do the following:
"theme_opts": {
   "search": false
 }
-

-
How does the search work?

-
If the search feature is enabled, you'll see a data folder in the output. This data folder contains a JSON
-called search.json. There is a fetch request when user types anything in the search box. That means search data is
-only loaded if user wants to search anything.

-
CodePen

-

-
Note: currently, this feature is only enabled for the examples section.

-

-
"theme_opts": {
+
How does the search work?
If the search feature is enabled, you'll see a data folder in the output. This data folder contains a JSON called search.json. There is a fetch request when user types anything in the search box. That means search data is only loaded if user wants to search anything.
CodePen
Note: currently, this feature is only enabled for the examples section.
"theme_opts": {
   "codepen": {
     "enable_for": ["examples"],
     "options": {
@@ -294,274 +104,45 @@ 
CodePen

     }
   }
 }
-

-
options can be any valid CodePen option. For more
-visit: Codepen Prefill options

-
Add static dir

-
To include static files:

-
"theme_opts": {
+
options can be any valid CodePen option. For more visit: Codepen Prefill options
Add static dir
To include static files:
"theme_opts": {
   "static_dir": ["./static"],
 }
-

-
Add styles

-
To create custom style rules. Example:

-
"theme_opts": {
+
Add styles
To create custom style rules. Example:
"theme_opts": {
   "create_style": ".sidebar-title { font-size: 2rem }"
 }
-

-
Add style paths

-
Use this option to add third party css library. If you want to add your own custom css file then consider
-using Add custom css files

-

-
Note: you have to pass an array of objects. Each object key will be an attribute inside the generated script tag.

-

-
Example:

-
"add_style_path": [
+
Add style paths
Use this option to add third party css library. If you want to add your own custom css file then consider using Add custom css files
Note: you have to pass an array of objects. Each object key will be an attribute inside the generated script tag.
Example:
"add_style_path": [
   {
     "href": "https://cdn.jsdelivr.net/npm/bootstrap@5.0.0-beta1/dist/css/bootstrap.min.css",
     "integrity": "sha384-giJF6kkoqNQ00vy+HMDP7azOuL0xtbfIcaT9wjKHr8RbDVddVHyTfAAsrekwKmP1",
     "crossorigin": "anonymous"
   }
 ],
-

-
Add custom css files

-
To include css files. Example:

-
"theme_opts": {
+
Add custom css files
To include css files. Example:
"theme_opts": {
   "include_css": ["./static/index.css", "./src/docs/index.css"]
 }
-

-

-
Note: you are not required to manually copy file to output dir.

-

-
It will include the css files to the output dir and also attach a link tag to the html pointing to the included css
-file.

-
Add scripts

-
To create custom scripts. Example:

-
"theme_opts": {
+
Note: you are not required to manually copy file to output dir.
It will include the css files to the output dir and also attach a link tag to the html pointing to the included css file.
Add scripts
To create custom scripts. Example:
"theme_opts": {
   "add_scripts": "function foo(){console.log('foo')} function bar() {console.log('bar')}"
 }
-

-
Add script paths

-
Use this option to add third party js library. If you want to add your own custom script file then consider
-using Add custom script files

-

-
Note: you have to pass an array of objects, and object keys are actually the attributes which you want in you script
-tag.

-

-
Example:

-
"add_script_path": [
+
Add script paths
Use this option to add third party js library. If you want to add your own custom script file then consider using Add custom script files
Note: you have to pass an array of objects, and object keys are actually the attributes which you want in you script tag.
Example:
"add_script_path": [
   {
     "href": "https://code.jquery.com/jquery-3.5.1.js",
     "integrity": "sha256-QWo7LDvxbWT2tbbQ97B53yJnYU3WhH/C8ycbRAkjPDc=",
     "crossorigin": "anonymous"
   }
 ],
-

-
This will copy the static folder to the output dir.

-

-
Note: if the directory doesn't exist then you may get an error. Also, directory is relative to your jsdoc config file.

-

-
This will not flatten the directory. Directory structure will be kept as it is.

-
Add custom script files

-
To include js files. Example:

-
"theme_opts": {
+
This will copy the static folder to the output dir.
Note: if the directory doesn't exist then you may get an error. Also, directory is relative to your jsdoc config file.
This will not flatten the directory. Directory structure will be kept as it is.
Add custom script files
To include js files. Example:
"theme_opts": {
   "include_js": ["./static/index.js", "./src/docs/index.js"]
 }
-

-

-
Note: you are not required to manually copy file to output dir.

-

-
It will include the js files to the output dir and also attach a script tag to the html pointing to the included js
-file.

-
-
"theme_opts": {
+
Note: you are not required to manually copy file to output dir.
It will include the js files to the output dir and also attach a script tag to the html pointing to the included js file.
"theme_opts": {
   "footer": "This is footer" // or <div class="footer-wrapper">This is a footer </div>
 }
-

-
To exclude inherited

-
To exclude inherited symbols. Example:

-
"exclude_inherited": true
-

-
This will remove all symbols (members, methods ...) that come from inherited parents.

-
Cheat sheet

-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
namedefaultuse caseexpected value(s)
default_theme"dark"To set the default theme"light" or "dark"
homepageTitle"Home"To set the title of homepagestring
titlenullTo set the titleHTML or string
base_url/To set the base URLstring
menunullTo render extra link in navbarArray of Object(s)
metanullMeta tag attributesArray of Object(s)
searchtrueTo render search or nottrue or false
codepen{}To open code in codepenObject
static_dirnullTo include static dirArray of string
create_stylenullTo create custom style rulesstring
add_style_pathnullTo add external css libraries/filesArray of Object(s)
include_cssnullTo include css filesArray of string
add_scriptsnullTo create custom scriptstring
add_script_pathnullTo add external js libraries/filesArray of Object(s)
include_jsnullTo include js filesstring
footernullTo render footerHTML or string
exclude_inheritedfalseTo exclude inherited symbolsboolean
sections["Modules", "Classes", "Externals", "Events", "Namespaces", "Mixins", "Tutorials", "Interfaces", "Global"]To order navbar/sidebar sections or to hide/remove navbar/sidebar sectionsArray<SECTION_TYPE>
displayModuleHeaderfalseIf you want the module name to appear on its pageboolean

-
Don't forget to add the following in your jsdoc config file, otherwise toc will not work on some pages.

-
"markdown": {
+
To exclude inherited
To exclude inherited symbols. Example:
"exclude_inherited": true
+
This will remove all symbols (members, methods ...) that come from inherited parents.
Cheat sheet
namedefaultuse caseexpected value(s)
default_theme"dark"To set the default theme"light" or "dark"
homepageTitle"Home"To set the title of homepagestring
titlenullTo set the titleHTML or string
base_url/To set the base URLstring
menunullTo render extra link in navbarArray of Object(s)
metanullMeta tag attributesArray of Object(s)
searchtrueTo render search or nottrue or false
codepen{}To open code in codepenObject
static_dirnullTo include static dirArray of string
create_stylenullTo create custom style rulesstring
add_style_pathnullTo add external css libraries/filesArray of Object(s)
include_cssnullTo include css filesArray of string
add_scriptsnullTo create custom scriptstring
add_script_pathnullTo add external js libraries/filesArray of Object(s)
include_jsnullTo include js filesstring
footernullTo render footerHTML or string
exclude_inheritedfalseTo exclude inherited symbolsboolean
sections["Modules", "Classes", "Externals", "Events", "Namespaces", "Mixins", "Tutorials", "Interfaces", "Global"]To order navbar/sidebar sections or to hide/remove navbar/sidebar sectionsArray<SECTION_TYPE>
displayModuleHeaderfalseIf you want the module name to appear on its pageboolean
Don't forget to add the following in your jsdoc config file, otherwise toc will not work on some pages.
"markdown": {
   "idInHeadings": true // This is important for clean-jsdoc-theme, otherwise some features might not work.
 }
-

-
Changelog

-
Changelog is moved
-to https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CHANGELOG.md

-
Developing

-
Before starting please go through
-our contributing guide.

-
git clone https://github.com/ankitskvmdam/clean-jsdoc-theme.git
+
Changelog
Changelog is moved to https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/CHANGELOG.md
Developing
Before starting please go through our contributing guide.
git clone https://github.com/ankitskvmdam/clean-jsdoc-theme.git
 cd clean-jsdoc-theme
 npm install
 npm install jsdoc --no-save
 npm run build
-

-
npm run build will generate files in output folder.

-
Contributors

-
-  clean-jsdoc-contributors
-
-
Thanks

-
Thanks to fuse.js, hljs,tippy.js, and
-all awesome contributors.

-
Contact

-
If you like my work, then give me
-a 
-star.

-
Mail me at: hello@ankdev.me 

-
License

-
Licensed under the MIT license.

-    

-
-
-
-
-
-
-

-
-
-
-

-
-

-    Documentation generated by JSDoc 4.0.0 on Sun Dec 18 2022 20:24:53 GMT+0530 (India Standard Time)
-

-
-
-
-
-
\ No newline at end of file
+

npm run build will generate files in output folder.

Contributors

clean-jsdoc-contributors

Thanks

Thanks to fuse.js, hljs,tippy.js, and all awesome contributors.

Contact

If you like my work, then give me a star.

Mail me at: hello@ankdev.me

License

Licensed under the MIT license.

clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/module-SqlJs.html b/output/v4/module-SqlJs.html index 881bc488..ed71b427 100644 --- a/output/v4/module-SqlJs.html +++ b/output/v4/module-SqlJs.html @@ -1,133 +1,3 @@ - - - - - JSDoc: Module: SqlJs - - - - - - - - - - -
- -

Module: SqlJs

- - - - - - -
- - -
- -
- - -
-
- - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/module-bookshelf.Book.html b/output/v4/module-bookshelf.Book.html index c72bac65..faeb7335 100644 --- a/output/v4/module-bookshelf.Book.html +++ b/output/v4/module-bookshelf.Book.html @@ -1,183 +1,3 @@ - - - - - JSDoc: Class: Book - - - - - - - - - - -
- -

Class: Book

- - - - - - -
- - -
- - -

- - color/mixer~bookshelf. - - Book - -

- - - -
- - -
-
- - - - - -

- new Book() -

- - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +
On this page

color/mixer~bookshelf. Book

clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/module-bookshelf.html b/output/v4/module-bookshelf.html index 909c59cd..341a9328 100644 --- a/output/v4/module-bookshelf.html +++ b/output/v4/module-bookshelf.html @@ -1,133 +1,3 @@ - - - - - JSDoc: Module: bookshelf - - - - - - - - - - -
- -

Module: bookshelf

- - - - - - -
- - -
- -
- - -
-
- - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/module-color_mixer.html b/output/v4/module-color_mixer.html index ddb1fe46..ac3ff4f4 100644 --- a/output/v4/module-color_mixer.html +++ b/output/v4/module-color_mixer.html @@ -1,133 +1,3 @@ - - - - - JSDoc: Module: color/mixer - - - - - - - - - - -
- -

Module: color/mixer

- - - - - - -
- - -
- -
- - -
-
- - - - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
-
Source
-
-
- - - - - - - -
- - - - - - -
- - - - - - - - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - - - - - \ No newline at end of file +
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/tutorial-Alive_.html b/output/v4/tutorial-Alive_.html index dcd9a7f4..d17709a8 100644 --- a/output/v4/tutorial-Alive_.html +++ b/output/v4/tutorial-Alive_.html @@ -1,61 +1,3 @@ - - - - - JSDoc: Tutorial: Alive - - - - - - - - - - -
- -

Tutorial: Alive

- -
- -
- - -

Alive

-
- -
- - - - - - Alive - - - Alive Tutorial - - -
- -
- -
- - - -
- - - - - - - \ No newline at end of file +
On this page

Alive

AliveAlive Tutorial
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/tutorial-Apple_.html b/output/v4/tutorial-Apple_.html index af84c08f..953ee06a 100644 --- a/output/v4/tutorial-Apple_.html +++ b/output/v4/tutorial-Apple_.html @@ -1,61 +1,3 @@ - - - - - JSDoc: Tutorial: Apple - - - - - - - - - - -
- -

Tutorial: Apple

- -
- -
- - -

Apple

-
- -
- - - - - - Apple - - - Apple Tutorial - - -
- -
- -
- - - -
- - - - - - - \ No newline at end of file +
On this page

Apple

AppleApple Tutorial
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/tutorial-Environment_.html b/output/v4/tutorial-Environment_.html index b7ea7dab..4249af5b 100644 --- a/output/v4/tutorial-Environment_.html +++ b/output/v4/tutorial-Environment_.html @@ -1,61 +1,3 @@ - - - - - JSDoc: Tutorial: Environment - - - - - - - - - - -
- -

Tutorial: Environment

- -
- -
- - -

Environment

-
- -
- - - - - - Environment - - - Environment Tutorial - - -
- -
- -
- - - -
- - - - - - - \ No newline at end of file +
On this page

Environment

EnvironmentEnvironment Tutorial
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/tutorial-Other.html b/output/v4/tutorial-Other.html index ca90df6b..8191b21b 100644 --- a/output/v4/tutorial-Other.html +++ b/output/v4/tutorial-Other.html @@ -1,61 +1,3 @@ - - - - - JSDoc: Tutorial: Other - - - - - - - - - - -
- -

Tutorial: Other

- -
- -
- - -

Other

-
- -
- - - - - - Other - - - Other Tutorial - - -
- -
- -
- - - -
- - - - - - - \ No newline at end of file +
On this page

Other

OtherOther Tutorial
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file