Plaster

Class: Plaster

Plaster

Main Plaster class. Use this class to set default options and create schemas and models.

new Plaster(options)

index.js, line 38

By default we export an instance of Plaster object.
Clients can create a new instances using the constructor.

Name Type Description
options Object

default schema options

Name Type Description
strict Boolean

By default (true), allow only values in the schema to be set.
When this is false, setting new fields will dynamically add the field
to the schema as type "any".
dotNotation Boolean

Allow fields to be set via dotNotation. Default: true.
obj['user.name'] = 'Joe'; -> obj: { user: 'Joe' }
Example
var plaster = require('plaster');


var schema = plaster.schema({ name: String });
var Cat = plaster.model('Cat', schema);
var kitty = new Cat({ name: 'Zildjian' });

Members

ModelModel

index.js, line 78

Expose the Model class

Example
var schema = plaster.schema({ name: String });
var Cat = plaster.model('Cat', schema);
var kitty = new Cat({ name: 'Zildjian' });
console.log(kitty insanceof plaster.Model); // true

ModelArrayModelArray

index.js, line 84

Expose the ModelArray class

PlasterPlaster

index.js, line 90

Expose Plaster constructor so clients can create new instances.

SchemaSchema

index.js, line 66

Expose the Schema class

Example
var schema = new plaster.Schema({ name: String});

Methods

get(){*}

index.js, line 148

Get option.

Returns:
Type Description
* Option value

getModel(name){*}

index.js, line 157

Returns the model given the name.

Name Type Description
name
Returns:
Type Description
*

model(name, schema, options)

index.js, line 115

Creates a model from a schema.

Name Type Description
name String

name of the model.
schema Schema

instance
options Object

options

Name Type Description
freeze Boolean

to freeze model. See Object.freeze. Default: true

modelNames(){Array}

index.js, line 167

Returns an array of model names created on this instance of Plaster.

Returns:
Type Description
Array Array of model names registered.

schema(descriptor, options){Object}

index.js, line 101

Creates a schema. Prefer to use this over Schema constructor as this will pass along Plaster config settings.

Name Type Description
descriptor Object

the schema descriptor
options Object

Schema options
Returns:
Type Description
Object created Schema instance

set(key, value)

index.js, line 134

Sets Plaster config options

Name Type Description
key String

the option key
value *

option value