Schema (druxt-schema)

Schema : `object`

The Druxt Schema object.

Kind: global typedef
Properties

Name	Type	Description
config	`SchemaConfiguration`	The schema configuration object.
data	`object`	The raw JSON:API resources data.
displayId	`string`	The Drupal Display ID.
druxtSchema	`DruxtSchema`	Instance of the Druxt Schema.
fields	`object`	The processed Field schema data.
id	`string`	The schema ID.
isValid	`boolean`	Valid if the Schema is a match for the configuration filters.
resourceType	`string`	The JSON:API resource type.

Example

{
  config: {
    bundle: 'page',
    entityType: 'node',
    filter: [],
    mode: 'default',
    schemaType: 'view',
  },
  data: {
    'entity_view_display--entity_view_display': [
      // Entity View Display JSON:API Resource data.
    ],
    'field_config--field_config': [
      // Field Config JSON:API Resource data.
    ],
  },
  displayId: 'node.page.default',
  druxtSchema: DruxtSchema {},
  fields: {
    body: {
      description: '',
      id: 'body',
      label: {
        position: 'hidden',
        text: 'Body',
      },
      required: false,
      settings: {
        config: {
          display_summary: true,
        },
        display: [],
      },
      thirdPartySettings: [],
      type: 'text_default',
      weight: 100,
    },
    ...
  },
  id: 'node--page--default--view',
  isValid: true,
  resourceType: 'node--page',
  schema: Schema { }
}

SchemaConfiguration : `object`

Druxt Schema configuration object.

Kind: global typedef
See: SchemaConfiguration