mirror of
https://github.com/balena-io/balena-cli.git
synced 2025-04-13 06:02:57 +00:00
Update docs
This commit is contained in:
parent
11f909510d
commit
25eedd22a0
doc
alphabetical_index.html
class
file/lib/resin
auth
config
data
device
errors
helpers
index.coffee.htmllog
models
_canvas.coffee.htmlapplication.coffee.htmldevice.coffee.htmlenvironment-variables.coffee.htmlindex.coffee.html
os
server
settings.coffee.htmltoken
lib
@ -266,7 +266,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:25 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -87,7 +87,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -83,7 +83,7 @@ Error: Invalid configuration file: /opt/resin.conf
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -70,7 +70,7 @@ Error: Invalid credentials
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -83,7 +83,7 @@ Error: You don't have any applications
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -83,7 +83,7 @@ Error: Couldn't find application
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -47,8 +47,9 @@
|
||||
</span>
|
||||
<span class='note private title'>Private</span>
|
||||
<span class='desc'>
|
||||
Authenticate with the server <pre><code>resin.auth.authenticate credentials, (error, token) -> throw error if error? console.log(token)
|
||||
</code></pre>
|
||||
Authenticate with the server <p>resin.auth.authenticate credentials, (error, token) ->
|
||||
throw error if error?
|
||||
console.log(token)</p>
|
||||
</span>
|
||||
</li>
|
||||
<li>
|
||||
@ -134,8 +135,9 @@
|
||||
<strong>Note:</strong>
|
||||
You should use login() when possible, as it takes care of saving the token as well.
|
||||
</div>
|
||||
<p>Authenticate with the server</p><pre><code>resin.auth.authenticate credentials, (error, token) -> throw error if error? console.log(token)
|
||||
</code></pre>
|
||||
<p>Authenticate with the server</p><p>resin.auth.authenticate credentials, (error, token) ->
|
||||
throw error if error?
|
||||
console.log(token)</p>
|
||||
</div>
|
||||
<div class='tags'>
|
||||
<h3>Parameters:</h3>
|
||||
@ -388,7 +390,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -119,7 +119,7 @@ console.log(contents.remoteUrl)
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -169,7 +169,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -37,7 +37,7 @@
|
||||
</table>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -156,7 +156,7 @@ console.log isDirectory('/Users/me/app.js') # False
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -186,7 +186,7 @@ console.log(devices)
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -94,7 +94,7 @@ resin.errors.handle(error, shouldExit)
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -159,7 +159,7 @@ console.log(object.dataPrefix) # /opt/resin
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -57,7 +57,7 @@
|
||||
</dl>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -348,7 +348,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -47,7 +47,7 @@
|
||||
</table>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -326,7 +326,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -316,7 +316,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -158,7 +158,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -52,7 +52,7 @@
|
||||
</dl>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -156,7 +156,7 @@ console.log(result)
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -227,7 +227,7 @@ resin.server.request { method: 'GET' url: '/download' p
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -77,7 +77,7 @@
|
||||
</dl>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -235,7 +235,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div id='footer'>
|
||||
December 08, 14 09:19:26 by
|
||||
December 08, 14 10:08:42 by
|
||||
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
||||
Codo
|
||||
</a>
|
||||
|
@ -14,7 +14,7 @@ exports.list = ->
|
||||
if not applicationId?
|
||||
resin.errors.handle(new Error('You have to specify an application'))
|
||||
|
||||
resin.models.environmentVariables.getAll applicationId, (error, environmentVariables) ->
|
||||
resin.models.environmentVariables.getAllByApplication applicationId, (error, environmentVariables) ->
|
||||
resin.errors.handle(error) if error?
|
||||
|
||||
if not cli.getArgument('verbose')?
|
||||
|
@ -8,14 +8,12 @@ errors = require('../errors/errors')
|
||||
#
|
||||
# @throw {NotFound} Will throw if no environment variable was found
|
||||
#
|
||||
# @todo Rename this to getAllByApplication
|
||||
#
|
||||
# @example Get all environment variables by application
|
||||
# resin.models.environmentVariables.getAll (error, environmentVariables) ->
|
||||
# throw error if error?
|
||||
# console.log(environmentVariables)
|
||||
#
|
||||
exports.getAll = (applicationId, callback) ->
|
||||
exports.getAllByApplication = (applicationId, callback) ->
|
||||
return canvas.get
|
||||
resource: 'environment_variable'
|
||||
options:
|
||||
|
Loading…
x
Reference in New Issue
Block a user