0.3.0

OSWS Templates 0.3.0

• JavaScript
• Pure object model
• Sync and async data
• Inheritance simplicity

Install

NPM

npm install -g oswst

CLI

Command line interface

> oswst --help
OSWS Templates CLI

  Usage: oswst [options]

  Options:

    -h, --help              output usage information
    -V, --version           output the version number
    -s, --source <path>     Specify source files. By default - all in this directory.
    -d, --dest <path>       Set output directory. By default - this directory.
    -w, --watch             Watch to source files.
    -u, --auto-exit         Enable auto exit by pressing Enter.
    --dirname <path>        Specify gulp-rename option.
    --basename <path>       Specify gulp-rename option.
    --prefix <path>         Specify gulp-rename option.
    --suffix <path>         Specify gulp-rename option.
    -e, --extname <path>        Specify gulp-rename option.

Types

• TData: Renderer|sync|async|Mixin
• TCallback: (error, result) => void
• TSelector: string
• TInjector: () => void
• TAttributes: [name: string]: TData
• TContext: TData

API

Node.js:

var T = require('oswst');

Require.js:

define(['oswst'], function(T) {});

window:

var T = window.oswst(_, async);

• Templates
  • .compile(filebody: string, filepath: string)
  • .include(id: string)
  • .render(data: TData, callback: TCallback, context?: TContext)
  • .renderContext(string: string, context: Object, callback: TCallback)
  • .renderAttributes(attributes: TAttributes, callback: TCallback, context?: TContext)
  • [.renderSelector(attributes: TAttributes, selector: TSelector)](0.3.0-Templates#renderSelector)
  • .sync(argument: Function)
  • .isSyncFunction(argument: Function)
  • .async(argument: Function)
  • .isAsyncFunction(argument: Function)
  • new .Prototype()
    • ._parent: Prototype
    • ._arguments: arguments
    • .returner() => any
    • .constructor(...arguments: TArguments) => any
    • .extend(...arguments: Array<TInjector|string>) => Function
    • ._static() => void
  • [new] .Renderer() > .Prototype
    • ._data: TData
    • .data(data: TData) => this
    • ._context: TContext
    • .context(...arguments: Array) => any
    • .render(...arguments: Array<TCallback|TContext>) => T.async
    • ._render(callback: TCallback, context: TContext) => void
    • .toString() => string
  • [new] .Data() > .Renderer
    • ._data: Array
    • .data: Array
    • .prepend: Array
    • .append: Array
  • [new] .data() > .Data
  • [new] .Tag(...arguments: Array<TSelector|TAttributes>) > .data
    • ._name: TData
    • .name(name: TData) => this
    • ._attributes: TAttributes
    • .attributes(attributes: TAttributes) => this
    • .selector(selector: TSelector) => this
    • ._renderTag(name: string, data: TData, attributes: TAttributes, callback: TCallback) => void
    • ._render(callback: TCallback, context: TContext) => void
  • [new] .Single(...arguments: Array<TSelector|TAttributes>) > .Tag
  • [new] .singles[string](...arguments: Array<TSelector|TAttributes>)
  • [new] .Double(...arguments: Array<TSelector|TAttributes>) => [new] (...arguments: Array) > .Tag
  • [new] .doubles[string](...arguments: Array<TSelector|TAttributes>) => [new] (...arguments: Array)
  • [new] .Doctype(...arguments: Array<TSelector|TAttributes>) > .Tag
  • [new] .doctypes[string](...arguments: Array<TSelector|TAttributes>)
  • [new] .xml(...arguments: Array<TSelector|TAttributes>) > .Tag
  • [new] .Mixin() > .Data
  • .mixin(reconstructor: Function) > .Mixin
  • [new] .mixins[string]: Templates.Mixin
  • [new] .Module(data: TData) => [new] (...arguments: any[]) > .Renderer
  • .with