From d097a4c5f1350287c4b243406c4bc8e28b2d2a10 Mon Sep 17 00:00:00 2001 From: Ankit Kumar Date: Thu, 29 Dec 2022 12:08:53 +0530 Subject: [PATCH] upgrade version --- README.md | 2 +- 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 | 4 ++-- 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/Statement.html | 4 ++-- 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/api.js.html | 4 ++-- 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.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 +- 31 files changed, 47 insertions(+), 47 deletions(-) diff --git a/README.md b/README.md index 8a8f8d80..853ed8cf 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # clean-jsdoc-theme -[![Stars](https://img.shields.io/github/stars/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme) [![Fork](https://img.shields.io/github/forks/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/fork) ![Version](https://img.shields.io/badge/version-4.2.1-005bff) [![Issues Open](https://img.shields.io/github/issues/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues) [![Contributors](https://img.shields.io/github/contributors/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors) [![Build Status](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme.svg?branch=production)](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme) [![license](https://img.shields.io/github/license/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE) +[![Stars](https://img.shields.io/github/stars/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme) [![Fork](https://img.shields.io/github/forks/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/fork) ![Version](https://img.shields.io/badge/version-4.2.2-005bff) [![Issues Open](https://img.shields.io/github/issues/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/issues) [![Contributors](https://img.shields.io/github/contributors/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/graphs/contributors) [![Build Status](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme.svg?branch=production)](https://travis-ci.org/ankitskvmdam/clean-jsdoc-theme) [![license](https://img.shields.io/github/license/ankitskvmdam/clean-jsdoc-theme)](https://github.com/ankitskvmdam/clean-jsdoc-theme/blob/master/LICENSE)
`clean-jsdoc-theme` is a beautifully crafted theme for JSDoc 3/JSDoc 4. It is a clean and fully responsive theme with loads of diff --git a/output/v4/Alive.html b/output/v4/Alive.html index 94f9b0bc..62bfd46b 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

(constant) FOO :number

A constant.

Type:
  • number
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

energy

amount of energy

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

Methods

gameQuery()

Text

Text

code
-

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

Source

survive(life) → {Energy}

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

This is an array of many things.

Deprecated
  • Yes
Source
Returns:

the energy wasted in this surviving instance

Type: 
Energy
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
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

(constant) FOO :number

A constant.

Type:
  • number
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

energy

amount of energy

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

Methods

gameQuery()

Text

Text

code
+

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

Source

survive(life) → {Energy}

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

This is an array of many things.

Deprecated
  • Yes
Source
Returns:

the energy wasted in this surviving instance

Type: 
Energy
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Alive.js.html b/output/v4/Alive.js.html index be44295a..3651c726 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
/**
  * @summary
  * This is a short summary of the `Alive` class. These texts are just acting
  * as filler texts for summary.
@@ -85,4 +85,4 @@
     get aLaMode() {
         return this.plain + ' with ice cream';
     }
-};

\ No newline at end of file
+};
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Apple.html b/output/v4/Apple.html index 4f79a032..6876635a 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

(constant) FOO :number

A constant.

Type:
  • number
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

energy

amount of energy

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

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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
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

(constant) FOO :number

A constant.

Type:
  • number
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

energy

amount of energy

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

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
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Apple.js.html b/output/v4/Apple.js.html index cc104bab..4f17f659 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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Database.html b/output/v4/Database.html index 9cd6f4a9..68652246 100644 --- a/output/v4/Database.html +++ b/output/v4/Database.html @@ -1,6 +1,6 @@ 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},
             function (row){console.log(row.name + " is a grown-up.")}
@@ -26,4 +26,4 @@
         "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

\ No newline at end of file
+

Type Definitions

QueryExecResult

Type:
  • Object
Properties
NameTypeDescription
columnsArray.<string>

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

valuesArray.<Array.<Database.SqlValue>>

one array per row, containing the column values

Source

SqlValue

Type:
  • string | number | null | Uint8Array
Source
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Energy.html b/output/v4/Energy.html index fd02374d..203aa24b 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
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Energy.js.html b/output/v4/Energy.js.html index 8fcaf965..3e83cd3e 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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Environment.html b/output/v4/Environment.html index 93f4133e..7b778711 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
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Environment.js.html b/output/v4/Environment.js.html index ea4d1e27..e03aa157 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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/HideConstructor.js.html b/output/v4/HideConstructor.js.html index bfe73def..b1dc18cb 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
  */
@@ -16,4 +16,4 @@
     start(config) {
 
     }
-}

\ No newline at end of file
+}
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Modules.js.html b/output/v4/Modules.js.html index 624d9006..4646b0e1 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) { },
@@ -18,4 +18,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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Statement.html b/output/v4/Statement.html index 2591f102..d4964c05 100644 --- a/output/v4/Statement.html +++ b/output/v4/Statement.html @@ -1,6 +1,6 @@ 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");
+    
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;"
         );
@@ -14,4 +14,4 @@
     // 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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/StatementIterator.html b/output/v4/StatementIterator.html index 26804b3e..f8e17a4f 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
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Test.html b/output/v4/Test.html index f0f698a1..4b47c7c5 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
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Tree.html b/output/v4/Tree.html index a437bb8d..f1d3cd72 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

(constant) FOO :number

A constant.

Type:
  • number
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

energy

amount of energy

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

Methods

crop(environment) → {Energy}

Parameters:
NameTypeDescription
environmentEnvironment

the environment when this Alive thing is surviving

Source
Fires:
  • Tree.event:crop
Throws:

Err

Returns:

the energy wasted in this surviving instance

Type: 
Energy

gameQuery()

Text

Text

code
-

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

Overrides
Source

survive(life) → {Energy}

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

This is an array of many things.

Overrides
Deprecated
  • Yes
Source
Returns:

the energy wasted in this surviving instance

Type: 
Energy
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
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

(constant) FOO :number

A constant.

Type:
  • number
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

energy

amount of energy

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

Methods

crop(environment) → {Energy}

Parameters:
NameTypeDescription
environmentEnvironment

the environment when this Alive thing is surviving

Source
Fires:
  • Tree.event:crop
Throws:

Err

Returns:

the energy wasted in this surviving instance

Type: 
Energy

gameQuery()

Text

Text

code
+

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

Overrides
Source

survive(life) → {Energy}

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

This is an array of many things.

Overrides
Deprecated
  • Yes
Source
Returns:

the energy wasted in this surviving instance

Type: 
Energy
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/Tree.js.html b/output/v4/Tree.js.html index 1575bb0c..f54a4199 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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/World.html b/output/v4/World.html index b673a694..fc3c34d8 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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/World.js.html b/output/v4/World.js.html index 5d8f22be..78f5253e 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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/api.js.html b/output/v4/api.js.html index e62ab2cd..210e823b 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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/global.html b/output/v4/global.html index 4f52def7..0c7939aa 100644 --- a/output/v4/global.html +++ b/output/v4/global.html @@ -1,3 +1,3 @@ Global
On this page

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

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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

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

SqlJs

Type:
  • Object
Properties
NameTypeDescription
DatabaseDatabase

A class that represents an SQLite database

StatementStatement

The prepared statement class

Source

SqlJsConfig

Type:
  • Object
Properties
NameTypeDescription
locateFilefunction

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

Source
See
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/index.html b/output/v4/index.html index f291a7d4..3ebf2f15 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": {
@@ -148,4 +148,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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/module-SqlJs.html b/output/v4/module-SqlJs.html index 6f1e0c3b..1d97469c 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
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/module-bookshelf.Book.html b/output/v4/module-bookshelf.Book.html index a65ed0fa..eb52edb3 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
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/module-bookshelf.html b/output/v4/module-bookshelf.html index 1160bd3e..a992d103 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
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/module-color_mixer.html b/output/v4/module-color_mixer.html index 0bb6efcc..0a6a1216 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
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/pieOptions.html b/output/v4/pieOptions.html index 903ed6d6..34e899e0 100644 --- a/output/v4/pieOptions.html +++ b/output/v4/pieOptions.html @@ -1,3 +1,3 @@ Namespace: pieOptions
On this page

pieOptions

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

pieOptions

clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/tutorial-Alive_.html b/output/v4/tutorial-Alive_.html index a48a13c9..c442d2a8 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
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/tutorial-Apple_.html b/output/v4/tutorial-Apple_.html index 1dff9b79..de6bb322 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
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/tutorial-Environment_.html b/output/v4/tutorial-Environment_.html index ea4e139c..41d409aa 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
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
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
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file diff --git a/output/v4/tutorial-Other.html b/output/v4/tutorial-Other.html index 8ba1cc32..219c817b 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
clean-jsdoc-theme
Github
npm
SqlJs
bookshelf
color/mixer
Classes
Alive
Apple
Database
Energy
Environment
Statement
StatementIterator
Test
Tree
World
Book
beEaten
beforeDestroy
pieOptions
Alive
Apple
Environment
Other
EnergyUnit
EnvironmentConfiguration
SqlJs
SqlJsConfig
fibonacci
initSqlJs
\ No newline at end of file +
On this page

Other

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