DruxtSchemaStore

DruxtSchemaStore

Vuex module, registered under the druxtSchema namespace. The druxtSchema Vuex module.

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

See: The DruxtStore

• druxtSchema
  • action
    • get(resource) ⇒ Schema
  • state : state
  • mutation
    • addSchema

get(resource) ⇒ Schema

Get a schema.
Vuex Action => Mutates state propertyschema

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

Example

const schema = await this.$store.dispatch('druxtSchema/get', { resourceType: 'node--page' })

state : state

The Vuex State object.

addSchema

Kind: mutation method of druxtSchema

Example

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

state : object

The Vuex State object.

Kind: global typedef
Properties

addSchemaPayload : object

Parameters for the addSchema mutation.

Kind: global typedef

Example

{
  id: 'node--page--default--view',
  schema: {}
}

Schema : object

The Druxt Schema object.

Kind: global typedef
See: Schema

SchemaConfiguration : object

Druxt Schema configuration object.

Kind: global typedef
See: SchemaConfiguration