Classes

DruxtSchema

The DruxtSchema class.

Builds Druxt Schema objects using Drupal JSON:API Entity Form and View Display mode data.

Typedefs

SchemaConfiguration : object

DruxtSchema

The DruxtSchema class.

Builds Druxt Schema objects using Drupal JSON:API Entity Form and View Display mode data.

Kind: global class
Todo

• Document DruxtSchema authentication options.
• Document DruxtSchema filter options.

• DruxtSchema
  • new DruxtSchema(baseUrl, [options])
  • .druxt : DruxtClient
  • .get() ⇒ object
  • .getSchema(config, [options]) ⇒ Schema

new DruxtSchema(baseUrl, [options])

DruxtSchemaRouter constructor.

• Validates module options.
• Sets up options.
• Sets up Druxt.js Router instance.
• (Optional) Sets up oauth2 authentication.

Example

const schema = new DruxtSchema('https://example.com', {})

.druxt : DruxtClient

Instance of the Druxt Client.

Kind: instance property of DruxtSchema
See: http://druxtjs.org/api/client

.get() ⇒ object

Gets all available schemas for Entitiy Views and Form modes.

Kind: instance method of DruxtSchema
Returns: object - The JSON:API Resource index and processed schemas.
Todo

• Rename the get() method to getAll().

Example

const { schemas } = await schema.get()

.getSchema(config, [options]) ⇒ Schema

Gets a matching schema as per the provided configuration.

Kind: instance method of DruxtSchema
Returns: Schema - The generated Schema.
See: Schema

Example

const config = {
  entityType: 'node',
  bundle: 'page'
}
const schema = await schema.getSchema(config)

SchemaConfiguration : object

Kind: global typedef
See: SchemaConfiguration