1.65.0 • Published 8 months ago

@totemorg/skin v1.65.0

Weekly downloads
-
License
ISC
Repository
github
Last release
8 months ago

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

ParamTypeDescription
reqObjectTotem request
resfunctionTotem response

SKIN.skinContext(req, cb)

Callback cb with skinning context ctx for requested table.

Kind: static method of SKIN

ParamTypeDescription
reqObjectTotem request
cbfunctioncallback(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

ParamTypeDescription
jadeStringcontents to render
ctxObjectskinning context
cbfunctioncallback(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

License

MIT


© 2012 ACMESDS

1.64.0

8 months ago

1.65.0

8 months ago

1.60.0

1 year ago

1.62.0

1 year ago

1.61.0

1 year ago

1.63.0

1 year ago

1.57.0

2 years ago

1.56.0

2 years ago

1.59.0

2 years ago

1.58.0

2 years ago

1.48.0

2 years ago

1.49.0

2 years ago

1.51.0

2 years ago

1.50.0

2 years ago

1.53.0

2 years ago

1.52.0

2 years ago

1.55.0

2 years ago

1.54.0

2 years ago

1.44.0

2 years ago

1.43.0

2 years ago

1.46.0

2 years ago

1.45.0

2 years ago

1.47.0

2 years ago

1.40.0

2 years ago

1.42.0

2 years ago

1.41.0

2 years ago

1.36.0

3 years ago

1.34.0

3 years ago

1.35.0

3 years ago

1.38.0

3 years ago

1.39.0

3 years ago

1.32.0

3 years ago

1.33.0

3 years ago

1.31.0

3 years ago

1.30.0

3 years ago

1.29.0

3 years ago

1.27.0

3 years ago

1.26.0

3 years ago

1.25.0

3 years ago

1.24.0

3 years ago

1.23.0

3 years ago

1.22.0

3 years ago

1.21.0

3 years ago

1.17.0

3 years ago