Class YamlPlugin

Plugin providing built-in custom YAML types.

Hierarchy

YamlPlugin

Implements

PluginComponent

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new YamlPlugin(pod: Pod, config: Record<string, any>): YamlPlugin

- Defined in packages/amagaki/src/plugins/yaml.ts:27
Parameters
- pod: Pod
- config: Record<string, any>
Returns YamlPlugin

Properties

config

config: Record<string, any>

pod

pod: Pod

Private shortcutTypes

shortcutTypes: YamlTypeArguments[]

Methods

addType

addType(tag: string, options: TypeConstructorOptions): void

- Defined in packages/amagaki/src/plugins/yaml.ts:49
Parameters
- tag: string
- options: TypeConstructorOptions
Returns void

createYamlTypesHook

createYamlTypesHook(yamlTypeManager: YamlTypeManager): void

Implementation of PluginComponent.createYamlTypesHook
- Defined in packages/amagaki/src/plugins/yaml.ts:56
Hook for defining custom yaml types for the yaml schema.

Parameters
- yamlTypeManager: YamlTypeManager
Returns void

Private partsLikeGlobOptions

partsLikeGlobOptions(parts: any): boolean

- Defined in packages/amagaki/src/plugins/yaml.ts:40
Returns whether supplied parts resemble the arguments for pod.docs or pod.collections. Supplied parts must be in the following format:
```
patterns?: string[] | string, options?: DocumentListOptions
```
Parameters
- parts: any
Returns boolean

Generated using TypeDoc