From c2a8cb2ebf4c5a3d2876d79f92e040885eada5f7 Mon Sep 17 00:00:00 2001 From: Ankit Kumar Date: Tue, 7 Nov 2023 07:30:53 +0900 Subject: [PATCH] generate output --- jsdoc-config.json | 32 ++++++++++++++++++------ output/v4/AgentArray.html | 4 +++ output/v4/Alive.html | 4 +-- output/v4/Alive.js.html | 4 +-- output/v4/Apple.html | 4 +-- output/v4/Apple.js.html | 4 +-- output/v4/Database.html | 10 ++++---- output/v4/Energy.html | 2 +- output/v4/Energy.js.html | 4 +-- output/v4/Environment.html | 2 +- output/v4/Environment.js.html | 4 +-- output/v4/HideConstructor.js.html | 4 +-- output/v4/Modules.js.html | 4 +-- output/v4/NamespaceWithAlias.js.html | 4 +-- output/v4/Statement.html | 10 ++++---- output/v4/StatementIterator.html | 2 +- output/v4/Test.html | 2 +- output/v4/Tree.html | 4 +-- output/v4/Tree.js.html | 4 +-- output/v4/World.html | 4 +-- output/v4/World.js.html | 4 +-- output/v4/agentscript.js.html | 19 ++++++++++++++ output/v4/api.js.html | 4 +-- output/v4/data/search.json | 2 +- output/v4/global.html | 2 +- output/v4/index.html | 4 +-- output/v4/module-SqlJs.html | 2 +- output/v4/module-bookshelf.Book.html | 2 +- output/v4/module-bookshelf.html | 2 +- output/v4/module-color_mixer-Colour.html | 2 +- output/v4/module-color_mixer.html | 2 +- output/v4/obj.map.html | 2 +- output/v4/pieOptions.html | 2 +- output/v4/tutorial-Alive_.html | 2 +- output/v4/tutorial-Apple_.html | 2 +- output/v4/tutorial-Environment_.html | 2 +- output/v4/tutorial-Other.html | 2 +- 37 files changed, 104 insertions(+), 65 deletions(-) create mode 100644 output/v4/AgentArray.html create mode 100644 output/v4/agentscript.js.html diff --git a/jsdoc-config.json b/jsdoc-config.json index 05bb890d..22d565e4 100644 --- a/jsdoc-config.json +++ b/jsdoc-config.json @@ -3,9 +3,14 @@ "allowUnknownTags": true }, "source": { - "include": ["./demo/src", "./README.md"] + "include": [ + "./demo/src", + "./README.md" + ] }, - "plugins": ["plugins/markdown"], + "plugins": [ + "plugins/markdown" + ], "opts": { "encoding": "utf8", "destination": "output/v4", @@ -18,9 +23,16 @@ "homepageTitle": "Clean JSDoc Theme", "default_theme": "dark", "exclude_inherited": false, - "include_css": ["./demo/src/assets/style.css"], - "include_js": ["./demo/src/assets/script.js"], - "static_dir": ["./demo/src/assets/png", "./example"], + "include_css": [ + "./demo/src/assets/style.css" + ], + "include_js": [ + "./demo/src/assets/script.js" + ], + "static_dir": [ + "./demo/src/assets/png", + "./example" + ], "add_scripts": "function foo(){console.log('foo')} function bar() {console.log('bar')} bar(); foo();", "create_style": ".test-create-style{ background: red}", "displayModuleHeader": true, @@ -49,7 +61,9 @@ } ], "codepen": { - "enable_for": ["examples"], + "enable_for": [ + "examples" + ], "options": { "js_external": "https://code.jquery.com/jquery-3.6.0.min.js", "js_pre_processor": "babel" @@ -61,7 +75,9 @@ "templates": { "default": { "staticFiles": { - "include": ["./example"] + "include": [ + "./example" + ] } } }, @@ -69,4 +85,4 @@ "hardwrap": false, "idInHeadings": true } -} +} \ No newline at end of file diff --git a/output/v4/AgentArray.html b/output/v4/AgentArray.html new file mode 100644 index 00000000..5a8904da --- /dev/null +++ b/output/v4/AgentArray.html @@ -0,0 +1,4 @@ +Class: AgentArray
On this page

AgentArray

Subclass of Array with convenience methods used by NetLogo. Typically the items in the array are Objects but can be any type.

Constructor

new AgentArray(args)

Creates an instance of AgentArray. Simply pass-through to super() now, but may add initialization code later.

Parameters:
NameTypeDescription
args*

Zero or more items in Array

Source
Example
let aa = new AgentArray({x:0,y:0}, {x:0,y:1}, {x:1,y:0})
+ console.log(aa) //=>  [{ x: 0, y: 0 }, { x: 0, y: 1 }, { x: 1, y: 0 }]
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Alive.html b/output/v4/Alive.html index 9ffca678..8099b222 100644 --- a/output/v4/Alive.html +++ b/output/v4/Alive.html @@ -1,4 +1,4 @@ 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

(readonly) FOO

A constant.

Deprecated
  • This is no longer used
Source

(constant) NUMBER_ARRAY :Object

This is a number array.

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

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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
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

(readonly) FOO

A constant.

Deprecated
  • This is no longer used
Source

(constant) NUMBER_ARRAY :Object

This is a number array.

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

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
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 de2dc0c0..b91e1db0 100644 --- a/output/v4/Alive.js.html +++ b/output/v4/Alive.js.html @@ -1,6 +1,6 @@ Source: Alive.js
On this page

Alive.js

/**
+    
On this page
Alive.js
/**
 * This object represents one size of a photo or a [file](https://core.telegram.org/bots/api/#document)
 * / [sticker](https://core.telegram.org/bots/api/#sticker)
 * thumbnail.
@@ -109,4 +109,4 @@
 
     }
 };
-

\ No newline at end of file
+
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Apple.html b/output/v4/Apple.html index a3ef96e6..e9badc4d 100644 --- a/output/v4/Apple.html +++ b/output/v4/Apple.html @@ -1,4 +1,4 @@ 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

(readonly) FOO

A constant.

Overrides
Deprecated
  • This is no longer used
Source

(constant) 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

Methods

(generator) 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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
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

(readonly) FOO

A constant.

Overrides
Deprecated
  • This is no longer used
Source

(constant) 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

Methods

(generator) 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
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 3346501d..f241e03f 100644 --- a/output/v4/Apple.js.html +++ b/output/v4/Apple.js.html @@ -1,6 +1,6 @@ Source: Apple.js
On this page

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
@@ -37,4 +37,4 @@
  *
  * @yields {number} The next number in the Fibonacci sequence.
  */
-function* fibonacci() { }

\ No newline at end of file
+function* fibonacci() { }
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Database.html b/output/v4/Database.html index 5ffa4275..fa4d3189 100644 --- a/output/v4/Database.html +++ b/output/v4/Database.html @@ -1,10 +1,10 @@ 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;})
+    
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},
+    
 
["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();
+    );
 
["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);"
@@ -21,9 +21,9 @@
         {"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
+
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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +

Type Definitions

QueryExecResult

Type:
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:
Source
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Energy.html b/output/v4/Energy.html index c943505e..5dd19001 100644 --- a/output/v4/Energy.html +++ b/output/v4/Energy.html @@ -1,3 +1,3 @@ Class: Energy
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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ 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
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 8fd6fea2..3d93dd9b 100644 --- a/output/v4/Energy.js.html +++ b/output/v4/Energy.js.html @@ -1,6 +1,6 @@ Source: Energy.js
On this page

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
  */
@@ -25,4 +25,4 @@
  * @property {String} foo kajsdh kajhsd
  * @property {Array<Array<String>>} hello aksjdh kaj shdkj asd
  */
-

\ No newline at end of file
+
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Environment.html b/output/v4/Environment.html index a5c4f4c9..51b659a9 100644 --- a/output/v4/Environment.html +++ b/output/v4/Environment.html @@ -1,3 +1,3 @@ Class: Environment
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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ 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
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 d75ca095..13bdbd9b 100644 --- a/output/v4/Environment.js.html +++ b/output/v4/Environment.js.html @@ -1,6 +1,6 @@ Source: Environment.js
On this page

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
@@ -41,4 +41,4 @@
  * @type {Energy}
  * @property {boolean} foo aalks djlas
  */
-

\ No newline at end of file
+
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 d14d5730..19c186c4 100644 --- a/output/v4/HideConstructor.js.html +++ b/output/v4/HideConstructor.js.html @@ -1,6 +1,6 @@ Source: HideConstructor.js
On this page

HideConstructor.js

/**
+    
On this page
HideConstructor.js
/**
  * Constructor should be hidden
  * @hideconstructor
  */
@@ -20,4 +20,4 @@
     start(config) {
 
     }
-}

\ No newline at end of file
+}
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 e671031c..ab15105f 100644 --- a/output/v4/Modules.js.html +++ b/output/v4/Modules.js.html @@ -1,6 +1,6 @@ Source: Modules.js
On this page

Modules.js

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

\ No newline at end of file
+};
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/NamespaceWithAlias.js.html b/output/v4/NamespaceWithAlias.js.html index 3095a212..b5cdef0d 100644 --- a/output/v4/NamespaceWithAlias.js.html +++ b/output/v4/NamespaceWithAlias.js.html @@ -1,6 +1,6 @@ Source: NamespaceWithAlias.js
On this page

NamespaceWithAlias.js

function create_public_interface(obj) {
+    
On this page
NamespaceWithAlias.js
function create_public_interface(obj) {
     /**
      * @namespace obj.map
      */
@@ -74,4 +74,4 @@
      */
     map.start0 = function () {}
 }
-

\ No newline at end of file
+
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Statement.html b/output/v4/Statement.html index 5d9c8113..8b9a9e5b 100644 --- a/output/v4/Statement.html +++ b/output/v4/Statement.html @@ -1,17 +1,17 @@ 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(
+    
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(
+        // 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);");
+    // 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

\ No newline at end of file
+

["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
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/StatementIterator.html b/output/v4/StatementIterator.html index 76e414a6..42ebfb72 100644 --- a/output/v4/StatementIterator.html +++ b/output/v4/StatementIterator.html @@ -1,3 +1,3 @@ Class: StatementIterator
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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ 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
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Test.html b/output/v4/Test.html index 49a28894..3632e691 100644 --- a/output/v4/Test.html +++ b/output/v4/Test.html @@ -1,3 +1,3 @@ Class: Test
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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

Test

Constructor should be hidden

clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Tree.html b/output/v4/Tree.html index 88ef8b91..6420c678 100644 --- a/output/v4/Tree.html +++ b/output/v4/Tree.html @@ -1,4 +1,4 @@ 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

(readonly) FOO

A constant.

Overrides
Deprecated
  • This is no longer used
Source

(constant) 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

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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
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

(readonly) FOO

A constant.

Overrides
Deprecated
  • This is no longer used
Source

(constant) 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

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
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 9c407bc1..5b467db1 100644 --- a/output/v4/Tree.js.html +++ b/output/v4/Tree.js.html @@ -1,6 +1,6 @@ Source: Tree.js
On this page

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
@@ -25,4 +25,4 @@
         return null;
     }
 }
-

\ No newline at end of file
+
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/World.html b/output/v4/World.html index cb1fd2fd..86703255 100644 --- a/output/v4/World.html +++ b/output/v4/World.html @@ -1,6 +1,6 @@ Class: World
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 = {
+    
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,
@@ -8,4 +8,4 @@
          minZ: integer,
          maxZ: integer,
      }
-
Constructor
new World()
Source
Methods
(static) 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

\ No newline at end of file
+

Constructor

new World()

Source

Methods

(static) 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
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 02b37897..ac0989fe 100644 --- a/output/v4/World.js.html +++ b/output/v4/World.js.html @@ -1,6 +1,6 @@ Source: World.js
On this page

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
@@ -64,4 +64,4 @@
         }
     }
 }
-

\ No newline at end of file
+
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/agentscript.js.html b/output/v4/agentscript.js.html new file mode 100644 index 00000000..85ceaecf --- /dev/null +++ b/output/v4/agentscript.js.html @@ -0,0 +1,19 @@ +Source: agentscript.js
On this page

agentscript.js

/**
+ * Subclass of Array with convenience methods used by NetLogo.
+ * Typically the items in the array are Objects but can be any type.
+ */
+class AgentArray extends Array {
+  /**
+  * Creates an instance of AgentArray. Simply pass-through to super()
+  * now, but may add initialization code later.
+  * @param {*} args Zero or more items in Array
+  * @example
+  * let aa = new AgentArray({x:0,y:0}, {x:0,y:1}, {x:1,y:0})
+  *  console.log(aa) //=>  [{ x: 0, y: 0 }, { x: 0, y: 1 }, { x: 1, y: 0 }]
+  */
+  constructor() {
+
+  }
+}
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 481b6f99..d6581d54 100644 --- a/output/v4/api.js.html +++ b/output/v4/api.js.html @@ -1,6 +1,6 @@ Source: api.js
On this page

api.js

/* global
+    
On this page
api.js
/* global
     ALLOC_NORMAL
     FS
     HEAP8
@@ -1133,4 +1133,4 @@
     };
     // export Database to Module
     Module.Database = Database;
-};

\ No newline at end of file
+};
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/data/search.json b/output/v4/data/search.json index 88dbf08b..86ba6a89 100644 --- a/output/v4/data/search.json +++ b/output/v4/data/search.json @@ -1 +1 @@ -{"list":[{"title":"Alive","link":"Alive"},{"title":"Alive#FOO","link":"FOO","description":"

A constant.

"},{"title":"Alive#NUMBER_ARRAY","link":"NUMBER_ARRAY","description":"

This is a number array.

"},{"title":"Alive#gameQuery","link":"gameQuery","description":"

Text

\n
\n

Text

\n
\n
code\n
\n
\n

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

\n
"},{"title":"Alive#survive","link":"survive"},{"title":"AliveEnergy","link":"AliveEnergy"},{"title":"Apple","link":"Apple"},{"title":"Apple#color","link":"color","description":"

Donec imperdiet dignissim

"},{"title":"Apple#event:beEaten","link":"beEaten","description":"

Sed vehicula purus dui

"},{"title":"Apple#fib","link":"fib","description":"

Generate the Fibonacci sequence of numbers.

"},{"title":"Database","link":"Database"},{"title":"Database#[\"close\"]","link":"[\"close\"]","description":"

Close the database, and all associated prepared statements.\nThe memory associated to the database and all associated statements\nwill be freed.

\n

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

\n

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

"},{"title":"Database#[\"create_function\"]","link":"[\"create_function\"]","description":"

Register a custom function with SQLite

"},{"title":"Database#[\"each\"]","link":"[\"each\"]","description":"

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

"},{"title":"Database#[\"exec\"]","link":"[\"exec\"]","description":"

Execute an SQL query, and returns the result.

\n

This is a wrapper against\n{@link Database.prepare},\n{@link Statement.bind},\n{@link Statement.step},\n{@link Statement.get},\nand {@link Statement.free}.

\n

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

\n

Example use

\n

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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
idagename
11Ling
218Paul
\n

We query it like that:

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

res is now :

\n
    [\n        {"columns":["id"],"values":[[1],[2]]},\n        {"columns":["age","name"],"values":[[1,"Ling"]]}\n    ]\n
"},{"title":"Database#[\"export\"]","link":"[\"export\"]","description":"

Exports the contents of the database to a binary array

"},{"title":"Database#[\"getRowsModified\"]","link":"[\"getRowsModified\"]","description":"

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

"},{"title":"Database#[\"handleError\"]","link":"[\"handleError\"]","description":"

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

"},{"title":"Database#[\"iterateStatements\"]","link":"[\"iterateStatements\"]","description":"

Iterate over multiple SQL statements in a SQL string.\nThis function returns an iterator over {@link Statement} objects.\nYou can use a for...of loop to execute the returned statements one by one.

"},{"title":"Database#[\"prepare\"]","link":"[\"prepare\"]","description":"

Prepare an SQL statement

"},{"title":"Database#[\"run\"]","link":"[\"run\"]","description":"

Execute an SQL query, ignoring the rows it returns.

"},{"title":"Database.QueryExecResult","link":"QueryExecResult"},{"title":"Database.SqlValue","link":"SqlValue"},{"title":"Energy","link":"Energy"},{"title":"Energy#amount","link":"amount","description":"

the amount of energy in this unit

"},{"title":"Energy#unit","link":"unit","description":"

Mauris interdum neque {@link Environment} id massa

"},{"title":"EnergyUnit","link":"EnergyUnit"},{"title":"Environment","link":"Environment"},{"title":"Environment#event:beforeDestroy","link":"beforeDestroy","description":"

Lorem ipsum dolor sit amet, {@link Energy} consectetur adipiscing el

"},{"title":"Environment#livingThings","link":"livingThings","description":"

All the living things in this environment

"},{"title":"Environment#name","link":"name","description":"

The name of this environment

"},{"title":"Environment#start","link":"start","description":"

Vestibulum condimentum tempus {@link Alive} diam.

"},{"title":"EnvironmentConfiguration","link":"EnvironmentConfiguration"},{"title":"PhotoSize","link":"PhotoSize","description":"

This object represents one size of a photo or a file\n/ sticker\nthumbnail.

"},{"title":"SqlJs","link":"SqlJs"},{"title":"SqlJsConfig","link":"SqlJsConfig"},{"title":"Statement","link":"Statement"},{"title":"Statement#[\"bind\"]","link":"[\"bind\"]","description":"

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

\n

SQL statements can have parameters,\nnamed '?', '?NNN', ':VVV', '@VVV', '$VVV',\nwhere NNN is a number and VVV a string.\nThis function binds these parameters to the given values.

\n

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

\n

Value types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Javascript typeSQLite type
numberREAL, INTEGER
booleanINTEGER
stringTEXT
Array, Uint8ArrayBLOB
nullNULL
"},{"title":"Statement#[\"free\"]","link":"[\"free\"]","description":"

Free the memory used by the statement

"},{"title":"Statement#[\"freemem\"]","link":"[\"freemem\"]","description":"

Free the memory allocated during parameter binding

"},{"title":"Statement#[\"get\"]","link":"[\"get\"]","description":"

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

"},{"title":"Statement#[\"getAsObject\"]","link":"[\"getAsObject\"]","description":"

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

"},{"title":"Statement#[\"getColumnNames\"]","link":"[\"getColumnNames\"]","description":"

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

"},{"title":"Statement#[\"getNormalizedSQL\"]","link":"[\"getNormalizedSQL\"]","description":"

Get the SQLite's normalized version of the SQL string used in\npreparing this statement. The meaning of "normalized" is not\nwell-defined: see {@link https://sqlite.org/c3ref/expanded_sql.html\nthe SQLite documentation}.

"},{"title":"Statement#[\"getSQL\"]","link":"[\"getSQL\"]","description":"

Get the SQL string used in preparing this statement.

"},{"title":"Statement#[\"reset\"]","link":"[\"reset\"]","description":"

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

"},{"title":"Statement#[\"run\"]","link":"[\"run\"]","description":"

Shorthand for bind + step + reset\nBind the values, execute the statement, ignoring the rows it returns,\nand resets it

"},{"title":"Statement#[\"step\"]","link":"[\"step\"]","description":"

Execute the statement, fetching the next line of result,\nthat can be retrieved with {@link Statement.get}.

"},{"title":"Statement.BindParams","link":"BindParams"},{"title":"StatementIterator","link":"StatementIterator"},{"title":"StatementIterator#[\"getRemainingSQL\"]","link":"[\"getRemainingSQL\"]","description":"

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

"},{"title":"StatementIterator#[\"next\"]","link":"[\"next\"]","description":"

Prepare the next available SQL statement

"},{"title":"StatementIterator.StatementIteratorResult","link":"StatementIteratorResult"},{"title":"Test","link":"Test"},{"title":"Test#start","link":"start"},{"title":"Tree","link":"Tree"},{"title":"Tree#branches","link":"branches","description":"

Donec imperdiet dignissim

"},{"title":"Tree#crop","link":"crop"},{"title":"World","link":"World"},{"title":"World.defaultOptions","link":"defaultOptions","description":"

Return a default options object, origin at center.

"},{"title":"fibonacci","link":"fibonacci","description":"

Generate the Fibonacci sequence of numbers.

"},{"title":"initSqlJs","link":"initSqlJs","description":"

Asynchronously initializes sql.js

"},{"title":"module:SqlJs","link":"SqlJs"},{"title":"module:bookshelf","link":"bookshelf"},{"title":"module:bookshelf.Book","link":"Book"},{"title":"module:bookshelf.Book#title","link":"title","description":"

The title.

"},{"title":"module:color/mixer","link":"color/mixer"},{"title":"module:color/mixer.blend","link":"blend","description":"

Blend two colours together.

"},{"title":"module:color/mixer.darken","link":"darken","description":"

Darkens a color.

"},{"title":"module:color/mixer.fib","link":"fib","description":"

Generator example

"},{"title":"module:color/mixer~Colour","link":"Colour","description":"

Create colour from rgb

"},{"title":"obj.map","link":"map"},{"title":"obj.map.aliasOfStart9","link":"aliasOfStart9","description":"

This is an alias. It's original name is start9

"},{"title":"obj.map.map.start","link":"map.start","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start0","link":"map.start0","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start1","link":"map.start1","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start2","link":"map.start2","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start3","link":"map.start3","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start4","link":"map.start4","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start5","link":"map.start5","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start6","link":"map.start6","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start7","link":"map.start7","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start8","link":"map.start8","description":"

Sample function that does nothing

"},{"title":"pieOptions","link":"pieOptions","description":"

Options for ordering a delicious slice of pie.

"},{"title":"pieOptions.aLaMode","link":"aLaMode","description":"

A la mode.

"},{"title":"pieOptions.aNamespaceFunction","link":"aNamespaceFunction","description":"

This is just a namespace functions.

"},{"title":"pieOptions.plain","link":"plain","description":"

Plain.

"}]} \ No newline at end of file +{"list":[{"title":"AgentArray","link":"AgentArray","description":"

Creates an instance of AgentArray. Simply pass-through to super()\nnow, but may add initialization code later.

"},{"title":"Alive","link":"Alive"},{"title":"Alive#FOO","link":"FOO","description":"

A constant.

"},{"title":"Alive#NUMBER_ARRAY","link":"NUMBER_ARRAY","description":"

This is a number array.

"},{"title":"Alive#gameQuery","link":"gameQuery","description":"

Text

\n
\n

Text

\n
\n
code\n
\n
\n

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

\n
"},{"title":"Alive#survive","link":"survive"},{"title":"AliveEnergy","link":"AliveEnergy"},{"title":"Apple","link":"Apple"},{"title":"Apple#color","link":"color","description":"

Donec imperdiet dignissim

"},{"title":"Apple#event:beEaten","link":"beEaten","description":"

Sed vehicula purus dui

"},{"title":"Apple#fib","link":"fib","description":"

Generate the Fibonacci sequence of numbers.

"},{"title":"Database","link":"Database"},{"title":"Database#[\"close\"]","link":"[\"close\"]","description":"

Close the database, and all associated prepared statements.\nThe memory associated to the database and all associated statements\nwill be freed.

\n

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

\n

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

"},{"title":"Database#[\"create_function\"]","link":"[\"create_function\"]","description":"

Register a custom function with SQLite

"},{"title":"Database#[\"each\"]","link":"[\"each\"]","description":"

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

"},{"title":"Database#[\"exec\"]","link":"[\"exec\"]","description":"

Execute an SQL query, and returns the result.

\n

This is a wrapper against\n{@link Database.prepare},\n{@link Statement.bind},\n{@link Statement.step},\n{@link Statement.get},\nand {@link Statement.free}.

\n

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

\n

Example use

\n

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

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
idagename
11Ling
218Paul
\n

We query it like that:

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

res is now :

\n
    [\n        {"columns":["id"],"values":[[1],[2]]},\n        {"columns":["age","name"],"values":[[1,"Ling"]]}\n    ]\n
"},{"title":"Database#[\"export\"]","link":"[\"export\"]","description":"

Exports the contents of the database to a binary array

"},{"title":"Database#[\"getRowsModified\"]","link":"[\"getRowsModified\"]","description":"

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

"},{"title":"Database#[\"handleError\"]","link":"[\"handleError\"]","description":"

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

"},{"title":"Database#[\"iterateStatements\"]","link":"[\"iterateStatements\"]","description":"

Iterate over multiple SQL statements in a SQL string.\nThis function returns an iterator over {@link Statement} objects.\nYou can use a for...of loop to execute the returned statements one by one.

"},{"title":"Database#[\"prepare\"]","link":"[\"prepare\"]","description":"

Prepare an SQL statement

"},{"title":"Database#[\"run\"]","link":"[\"run\"]","description":"

Execute an SQL query, ignoring the rows it returns.

"},{"title":"Database.QueryExecResult","link":"QueryExecResult"},{"title":"Database.SqlValue","link":"SqlValue"},{"title":"Energy","link":"Energy"},{"title":"Energy#amount","link":"amount","description":"

the amount of energy in this unit

"},{"title":"Energy#unit","link":"unit","description":"

Mauris interdum neque {@link Environment} id massa

"},{"title":"EnergyUnit","link":"EnergyUnit"},{"title":"Environment","link":"Environment"},{"title":"Environment#event:beforeDestroy","link":"beforeDestroy","description":"

Lorem ipsum dolor sit amet, {@link Energy} consectetur adipiscing el

"},{"title":"Environment#livingThings","link":"livingThings","description":"

All the living things in this environment

"},{"title":"Environment#name","link":"name","description":"

The name of this environment

"},{"title":"Environment#start","link":"start","description":"

Vestibulum condimentum tempus {@link Alive} diam.

"},{"title":"EnvironmentConfiguration","link":"EnvironmentConfiguration"},{"title":"PhotoSize","link":"PhotoSize","description":"

This object represents one size of a photo or a file\n/ sticker\nthumbnail.

"},{"title":"SqlJs","link":"SqlJs"},{"title":"SqlJsConfig","link":"SqlJsConfig"},{"title":"Statement","link":"Statement"},{"title":"Statement#[\"bind\"]","link":"[\"bind\"]","description":"

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

\n

SQL statements can have parameters,\nnamed '?', '?NNN', ':VVV', '@VVV', '$VVV',\nwhere NNN is a number and VVV a string.\nThis function binds these parameters to the given values.

\n

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

\n

Value types

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Javascript typeSQLite type
numberREAL, INTEGER
booleanINTEGER
stringTEXT
Array, Uint8ArrayBLOB
nullNULL
"},{"title":"Statement#[\"free\"]","link":"[\"free\"]","description":"

Free the memory used by the statement

"},{"title":"Statement#[\"freemem\"]","link":"[\"freemem\"]","description":"

Free the memory allocated during parameter binding

"},{"title":"Statement#[\"get\"]","link":"[\"get\"]","description":"

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

"},{"title":"Statement#[\"getAsObject\"]","link":"[\"getAsObject\"]","description":"

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

"},{"title":"Statement#[\"getColumnNames\"]","link":"[\"getColumnNames\"]","description":"

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

"},{"title":"Statement#[\"getNormalizedSQL\"]","link":"[\"getNormalizedSQL\"]","description":"

Get the SQLite's normalized version of the SQL string used in\npreparing this statement. The meaning of "normalized" is not\nwell-defined: see {@link https://sqlite.org/c3ref/expanded_sql.html\nthe SQLite documentation}.

"},{"title":"Statement#[\"getSQL\"]","link":"[\"getSQL\"]","description":"

Get the SQL string used in preparing this statement.

"},{"title":"Statement#[\"reset\"]","link":"[\"reset\"]","description":"

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

"},{"title":"Statement#[\"run\"]","link":"[\"run\"]","description":"

Shorthand for bind + step + reset\nBind the values, execute the statement, ignoring the rows it returns,\nand resets it

"},{"title":"Statement#[\"step\"]","link":"[\"step\"]","description":"

Execute the statement, fetching the next line of result,\nthat can be retrieved with {@link Statement.get}.

"},{"title":"Statement.BindParams","link":"BindParams"},{"title":"StatementIterator","link":"StatementIterator"},{"title":"StatementIterator#[\"getRemainingSQL\"]","link":"[\"getRemainingSQL\"]","description":"

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

"},{"title":"StatementIterator#[\"next\"]","link":"[\"next\"]","description":"

Prepare the next available SQL statement

"},{"title":"StatementIterator.StatementIteratorResult","link":"StatementIteratorResult"},{"title":"Test","link":"Test"},{"title":"Test#start","link":"start"},{"title":"Tree","link":"Tree"},{"title":"Tree#branches","link":"branches","description":"

Donec imperdiet dignissim

"},{"title":"Tree#crop","link":"crop"},{"title":"World","link":"World"},{"title":"World.defaultOptions","link":"defaultOptions","description":"

Return a default options object, origin at center.

"},{"title":"fibonacci","link":"fibonacci","description":"

Generate the Fibonacci sequence of numbers.

"},{"title":"initSqlJs","link":"initSqlJs","description":"

Asynchronously initializes sql.js

"},{"title":"module:SqlJs","link":"SqlJs"},{"title":"module:bookshelf","link":"bookshelf"},{"title":"module:bookshelf.Book","link":"Book"},{"title":"module:bookshelf.Book#title","link":"title","description":"

The title.

"},{"title":"module:color/mixer","link":"color/mixer"},{"title":"module:color/mixer.blend","link":"blend","description":"

Blend two colours together.

"},{"title":"module:color/mixer.darken","link":"darken","description":"

Darkens a color.

"},{"title":"module:color/mixer.fib","link":"fib","description":"

Generator example

"},{"title":"module:color/mixer~Colour","link":"Colour","description":"

Create colour from rgb

"},{"title":"obj.map","link":"map"},{"title":"obj.map.aliasOfStart9","link":"aliasOfStart9","description":"

This is an alias. It's original name is start9

"},{"title":"obj.map.map.start","link":"map.start","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start0","link":"map.start0","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start1","link":"map.start1","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start2","link":"map.start2","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start3","link":"map.start3","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start4","link":"map.start4","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start5","link":"map.start5","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start6","link":"map.start6","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start7","link":"map.start7","description":"

Sample function that does nothing

"},{"title":"obj.map.map.start8","link":"map.start8","description":"

Sample function that does nothing

"},{"title":"pieOptions","link":"pieOptions","description":"

Options for ordering a delicious slice of pie.

"},{"title":"pieOptions.aLaMode","link":"aLaMode","description":"

A la mode.

"},{"title":"pieOptions.aNamespaceFunction","link":"aNamespaceFunction","description":"

This is just a namespace functions.

"},{"title":"pieOptions.plain","link":"plain","description":"

Plain.

"}]} \ No newline at end of file diff --git a/output/v4/global.html b/output/v4/global.html index fa054594..12603594 100644 --- a/output/v4/global.html +++ b/output/v4/global.html @@ -1,3 +1,3 @@ Global
On this page

Members

AliveEnergy

amount of energy

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

Methods

(generator) 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

PhotoSize

This object represents one size of a photo or a file / sticker thumbnail.

Type:
  • object
Properties
NameTypeAttributesDescription
file_idstring

Identifier for this file, which can be used to download or reuse the file

file_unique_idstring

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

widthnumber

Photo width

heightnumber

Photo height

file_sizenumber<optional>

Optional. File size in bytes

Source
See

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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

Members

AliveEnergy

amount of energy

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

Methods

(generator) 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

PhotoSize

This object represents one size of a photo or a file / sticker thumbnail.

Type:
  • object
Properties
NameTypeAttributesDescription
file_idstring

Identifier for this file, which can be used to download or reuse the file

file_unique_idstring

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

widthnumber

Photo width

heightnumber

Photo height

file_sizenumber<optional>

Optional. File size in bytes

Source
See

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
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/index.html b/output/v4/index.html index ea4cde41..b80c44d8 100644 --- a/output/v4/index.html +++ b/output/v4/index.html @@ -1,6 +1,6 @@ Clean JSDoc Theme
On this page

clean-jsdoc-theme

StarsForkVersion Issues OpenContributorsBuild Statuslicense

clean-jsdoc-theme is a beautifully crafted theme for JSDoc 3/JSDoc 4. 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
+    
On this page
clean-jsdoc-theme
StarsForkVersion Issues OpenContributorsBuild Statuslicense
clean-jsdoc-theme is a beautifully crafted theme for JSDoc 3/JSDoc 4. 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": {
@@ -186,4 +186,4 @@
 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.

\ 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
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 8419cfc9..fadb84d9 100644 --- a/output/v4/module-SqlJs.html +++ b/output/v4/module-SqlJs.html @@ -1,3 +1,3 @@ Module: SqlJs
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 1d41a1f5..d82e32c4 100644 --- a/output/v4/module-bookshelf.Book.html +++ b/output/v4/module-bookshelf.Book.html @@ -1,3 +1,3 @@ Class: Book
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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

color/mixer~bookshelf. Book

clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 015811d0..fdbf918b 100644 --- a/output/v4/module-bookshelf.html +++ b/output/v4/module-bookshelf.html @@ -1,3 +1,3 @@ Module: bookshelf
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/module-color_mixer-Colour.html b/output/v4/module-color_mixer-Colour.html index 030235be..d47b4ce7 100644 --- a/output/v4/module-color_mixer-Colour.html +++ b/output/v4/module-color_mixer-Colour.html @@ -1,3 +1,3 @@ Class: Colour
On this page

color/mixer~ Colour

Class that represents a colour

clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

color/mixer~ Colour

Class that represents a colour

clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 10f11269..1208b222 100644 --- a/output/v4/module-color_mixer.html +++ b/output/v4/module-color_mixer.html @@ -1,3 +1,3 @@ Module: color/mixer
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/obj.map.html b/output/v4/obj.map.html index a4f71d33..f1a79dca 100644 --- a/output/v4/obj.map.html +++ b/output/v4/obj.map.html @@ -1,3 +1,3 @@ Namespace: map
On this page

map

Source

Methods

(static) aliasOfStart9()

This is an alias. It's original name is start9

Source

(static) map.start()

Sample function that does nothing

Source

(static) map.start0()

Sample function that does nothing

Source

(static) map.start1()

Sample function that does nothing

Source

(static) map.start2()

Sample function that does nothing

Source

(static) map.start3()

Sample function that does nothing

Source

(static) map.start4()

Sample function that does nothing

Source

(static) map.start5()

Sample function that does nothing

Source

(static) map.start6()

Sample function that does nothing

Source

(static) map.start7()

Sample function that does nothing

Source

(static) map.start8()

Sample function that does nothing

Source
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

map

Source

Methods

(static) aliasOfStart9()

This is an alias. It's original name is start9

Source

(static) map.start()

Sample function that does nothing

Source

(static) map.start0()

Sample function that does nothing

Source

(static) map.start1()

Sample function that does nothing

Source

(static) map.start2()

Sample function that does nothing

Source

(static) map.start3()

Sample function that does nothing

Source

(static) map.start4()

Sample function that does nothing

Source

(static) map.start5()

Sample function that does nothing

Source

(static) map.start6()

Sample function that does nothing

Source

(static) map.start7()

Sample function that does nothing

Source

(static) map.start8()

Sample function that does nothing

Source
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/pieOptions.html b/output/v4/pieOptions.html index 41ac35e0..4c91561a 100644 --- a/output/v4/pieOptions.html +++ b/output/v4/pieOptions.html @@ -1,3 +1,3 @@ Namespace: pieOptions
On this page

pieOptions

Options for ordering a delicious slice of pie.

Source

Members

(static, readonly) aLaMode

A la mode.

Source

(static) plain

Plain.

Source

Methods

(static) aNamespaceFunction(args)

This is just a namespace functions.

Parameters:
NameTypeDescription
argsnumber
Source
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

pieOptions

Options for ordering a delicious slice of pie.

Source

Members

(static, readonly) aLaMode

A la mode.

Source

(static) plain

Plain.

Source

Methods

(static) aNamespaceFunction(args)

This is just a namespace functions.

Parameters:
NameTypeDescription
argsnumber
Source
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 ee00a148..d01a526e 100644 --- a/output/v4/tutorial-Alive_.html +++ b/output/v4/tutorial-Alive_.html @@ -1,3 +1,3 @@ Tutorial: Alive
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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

Alive

AliveAlive Tutorial
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 caa0c093..955029e6 100644 --- a/output/v4/tutorial-Apple_.html +++ b/output/v4/tutorial-Apple_.html @@ -1,3 +1,3 @@ Tutorial: Apple
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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

Apple

AppleApple Tutorial
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 7d154afc..f98498f8 100644 --- a/output/v4/tutorial-Environment_.html +++ b/output/v4/tutorial-Environment_.html @@ -1,3 +1,3 @@ Tutorial: Environment
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
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

Environment

EnvironmentEnvironment Tutorial
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
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 573e08bd..c3018dea 100644 --- a/output/v4/tutorial-Other.html +++ b/output/v4/tutorial-Other.html @@ -1,3 +1,3 @@ Tutorial: Other
On this page

Other

OtherOther Tutorial
This is second line just to test search
This is not of any use please ignore these files. It is here only for testing purpose.
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
Namespaces
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

Other

OtherOther Tutorial
This is second line just to test search
This is not of any use please ignore these files. It is here only for testing purpose.
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
AgentArray
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
bookshelf~ Book
color_mixer~ Colour
Events
beEaten
beforeDestroy
map
pieOptions
Alive
Apple
Environment
Other
AliveEnergy
EnergyUnit
EnvironmentConfiguration
PhotoSize
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file