# Modules

druxtSchema

The druxtSchema Vuex module.

Provides a Vuex state object, mutations and actions for interacting with the Druxt Schemas.

# Typedefs

state : object

The Vuex State object.

Schema : object
SchemaConfiguration : object

# druxtSchema

The druxtSchema Vuex module.

Provides a Vuex state object, mutations and actions for interacting with the Druxt Schemas.


# get(resource) ⇒ Schema

Get a schema.
Vuex Action => Mutates state propertyschema

Kind: action method of druxtSchema
Returns: Schema - The Druxt Schema object.

Param Type Description
resource SchemaConfiguration The requested resource schema configuration object.

Example

const schema = await this.$store.dispatch('druxtRouter/get', '/')
1

# state : state

The Vuex State object.


# addSchema

Kind: mutation method of druxtSchema

Param Type Description
state state The Vuex State object.
data object Schema object and ID to be committed.

Example

this.$store.commit('druxtSchema/addSchema', { id, schema }})
1

# state : object

The Vuex State object.

Kind: global typedef
Properties

Name Type Description
schemas object Druxt Schemas, keyed by Schema ID.

# Schema : object

Kind: global typedef
See: Schema


# SchemaConfiguration : object

Kind: global typedef
See: SchemaConfiguration