app.index - loltgt/appe GitHub Wiki

app.load

Helper app load function DOM

<Function>

arguments:

<Function> func
<Boolean>

returns.

position:

 

app.unload

Helper app unload function DOM

<Function>

arguments:

<Function> func

returns.

position:

 

app.beforeunload

Helper app before unload function DOM

<Function>

arguments:

<Function> func

returns.

position:

 

app.position

Returns JSON serialized app position

<Function>

returns:

<String> position

position:

 

app.session

Initializes the session, returns to callback

<Function>   // asyncronous

globals:

<Object> appe__store
<Object> appe__locale
<Object> CryptoJS
<Object> pako

arguments:

<Function> callback
<Object> config
<String> target

returns.

position:

 

app.resume

Resumes session, returns last opened file

<Function>

arguments:

<Object> config
<Boolean> target

returns:

<String> session_resume

position:

 

app.redirect

Performs app redirect

<Function>

globals:

<Object> appe__config

returns.

position:

 

app.data

Gets data store

<Function>

globals:

<Object> appe__store

arguments:

<String> key

returns:

<Object>

position:

 

app.checkConfig

Verifies config file

<Function>

arguments:

<Object> config

returns:

<Boolean>

position:

 

app.checkFile

Verifies opened file

<Function>

globals:

<Object> appe__config

arguments:

<Object> source
<Object> checksum

returns:

<Boolean>

position:

 

app.openSessionFile

Opens session from an app session file

<Function>

globals:

<Object> appe__config
<Object> appe__start
<Object> CryptoJS
<Function> pako

arguments:

<Object> source

returns.

position:

 

app.saveSessionFile

Saves session to app session file

<Function>

globals:

<Object> appe__config
<Object> appe__store
<Object> appe__start
<Object> CryptoJS
<Function> pako

arguments:

<Object> source

position:

 

app.newSession

Creates a new empty session

<Function>

globals:

<Object> appe__config
<Object> appe__start

returns.

position:

 

app.openSession

Opens session, alias of app.openSessionFile

<Function>

position:

 

app.saveSession

Saves session, alias of app.saveSessionFile

<Function>

position:

 

app.asyncAttemptLoad

Attemps to load files and scripts, returns to callback

<Function>   // asyncronous

globals:

<Object> appe__config
<Object> CryptoJS

arguments:

<Function> callback
<Boolean> resume_session
<String> fn
<String> file
<Object> schema
<Boolean> memoize

returns.

position:

 

app.asyncLoadAux

Load extension scripts asyncronously, returns to callback

<Function>   // asyncronous

globals:

<Object> appe__config

arguments:

<Function> callback
<Object> routine
<Boolean> resume_session

returns.

position:

 

app.i18n

App localization

TODO: implement nest replacement 
<Function>

globals:

<Object> appe__locale

arguments:

<String> to_translate
<String> context
to_replace

position:

 

app.debug

Utility debug

<Function>

arguments:

<Object> source

returns:

<Boolean>

position:

 

app.stop

Stops the app execution

<Function>

globals:

<Object> appe__main

arguments:

<String> arg0   ( msg | fn )
arg1   ( log | msg )
arg2   ( log | msg )
<Boolean> soft

returns:

<Boolean>

position:

 

app.error

Helper to debug and display error messages

<Function>

globals:

<Object> appe__control

arguments:

<String> arg0   fn
arg1   ( log | msg )
arg2   ( log | msg )
<Boolean> soft

returns:

<undefined>

position:

 

app.blind

Helper to freeze "main" screen

<Function>

globals:

<Object> appe__main

returns.

position:

 

app.getInfo

Utility to get app info(s)

<Function>

globals:

<Object> appe__config

arguments:

<String> from   ( config | runtime )
<String> info   { config { app_name | schema | license } } | runtime { { debug | locale | version | release } }

returns.

position:

 

app.getName

Gets app name

<Function>

returns:

<String>

position:

 

app.getVersion

Gets app version

<Function>

arguments:

<String> info

returns.

position:

 

app.getLicense

Gets app license

<Function>

returns.

position:

 

app.getLocale

Gets app locale language

<Function>

returns:

<String>

position:

 

⚠️ **GitHub.com Fallback** ⚠️