@totemorg/skin v1.65.0
SKIN
The SKIN TOTEM plugin provides:
/DATASET.TYPE ? QUERY
/AREA/FILE ? QUERY
/AREA/STORE ? QUERY
/AREA/GRAPH ? QUERY
/AREA/ ? QUERY
endpoints to render datasets, folders, graphs per client API requireents where the optional TYPE:
view | help
specifies the rendering mode.
Install
npm install @totemstan/skin # Install
npm update
Manage
npm run start [ ? | $ | ...] # Unit test
npm run verminor # Roll minor version
npm run vermajor # Roll major version
npm run redoc # Regen documentation
npm run pubminor # republish as minor version
npm run pubmajor # republish as major version
Usage
Acquire and optionally configure SKIN:
const SKIN = require("skin").config({
key: value, // set key
"key.key": value, // indexed set
"key.key.": value // indexed append
});
where configuration keys follow ENUMS deep copy conventions.
Program Reference
SKIN
Provides methods to render Jade skins. This module documented IAW jsdoc.
Requires: module:enums, module:fs, module:cluster, module:jade@1.9.0
Author: ACMESDS
SKIN.lookups
Kind: static constant of SKIN
SKIN.blogCtx
Blogging context.
Kind: static constant of SKIN
SKIN.skinCtx
Kind: static constant of SKIN
SKIN.renderSkin(req, res)
Endpoint to render req.table using associated jade engine.
Kind: static method of SKIN
Param | Type | Description |
---|---|---|
req | Object | Totem request |
res | function | Totem response |
SKIN.skinContext(req, cb)
Callback cb with skinning context ctx for requested table.
Kind: static method of SKIN
Param | Type | Description |
---|---|---|
req | Object | Totem request |
cb | function | callback(ctx) |
SKIN.renderJade(jade, ctx, cb)
Render jade string to callback cb( err || html ) in a new context created for this request.
Kind: static method of SKIN
Param | Type | Description |
---|---|---|
jade | String | contents to render |
ctx | Object | skinning context |
cb | function | callback(ctx) |
SKIN~SQL
Kind: inner constant of SKIN
SKIN~ERROR
Client error messages
Kind: inner constant of SKIN
ERROR.noSkin
Requested skin not found - check spelling
Kind: static property of ERROR
ERROR.badSkin
Requested skin contains invalid jade markdown
Kind: static property of ERROR
ERROR.noEngine
Requested engine not found - check spelling
Kind: static property of ERROR
Contacting, Contributing, Following
Feel free to
- submit and status TOTEM issues
- contribute to TOTEM notebooks
- revise TOTEM requirements
- browse TOTEM holdings
- or follow TOTEM milestones
License
© 2012 ACMESDS
8 months ago
8 months ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago