config

Documentation

Index

• Constants
• Variables
• type Config
• type FieldDefinition
• type IdentifierDefinition
• type IncludeDefinition
• type TypeDefinition
• type WriteDefaults
• type WriteDefinition
• type WriteFormat

Constants

const (
	// WriteFormatYAML encodes YAML documents.
	WriteFormatYAML = internalconfig.WriteFormatYAML
	// WriteFormatJSON encodes JSON documents.
	WriteFormatJSON = internalconfig.WriteFormatJSON
)

const CurrentVersion = internalconfig.CurrentVersion

CurrentVersion defines the supported mergeway.yaml schema version.

const DefaultWriteTemplate = internalconfig.DefaultWriteTemplate

DefaultWriteTemplate describes the default file template.

Variables

var Load = internalconfig.Load

Load reads the mergeway configuration and resolves includes.

Types

type Config

type Config = internalconfig.Config

Config re-exports the internal configuration struct for external consumers.

type FieldDefinition

type FieldDefinition = internalconfig.FieldDefinition

FieldDefinition exposes field metadata for a type.

type IdentifierDefinition

type IdentifierDefinition = internalconfig.IdentifierDefinition

IdentifierDefinition exposes identifier metadata for a type.

type IncludeDefinition

type IncludeDefinition = internalconfig.IncludeDefinition

IncludeDefinition exposes include directives for a type.

type TypeDefinition

type TypeDefinition = internalconfig.TypeDefinition

TypeDefinition exposes entity type metadata.

type WriteDefaults

type WriteDefaults = internalconfig.WriteDefaults

WriteDefaults exposes global write descriptors.

type WriteDefinition

type WriteDefinition = internalconfig.WriteDefinition

WriteDefinition exposes per-type write configuration.

type WriteFormat

type WriteFormat = internalconfig.WriteFormat

WriteFormat enumerates supported output formats.