DruxtSchema

The DruxtSchema class.

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

Kind: global class

DruxtSchema constructor.

Param	Type	Default	Description
baseUrl	`string`		The Drupal base URL.
[options]	`object`		Druxt Router options.
[options.axios]	`object`		Axios instance settings.
[options.endpoint]	`string`	`"jsonapi"`	The JSON:API endpoint.

Example

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

Instance of the Druxt Client.

Kind: instance property of DruxtSchema
See: DruxtClient

Gets all available schemas for Entity Views and Form modes.

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

Example

const { schemas } = await schema.get()

Gets a matching schema as per the provided configuration.

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

Param	Type	Description
config	`SchemaConfiguration`	The Schema configuration object.
config.entityType	`string`	The Drupal Entity type.
config.bundle	`string`	The Entity bundle.
[options]	`object`	(Optional) Additional Schema generation options, e.g. preloaded JSON:API resource data.

Example

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

SchemaConfiguration : `object`

Druxt Schema configuration object.

Kind: global typedef
See: SchemaConfiguration