Type Alias SourceAdapter

SourceAdapter: {
    allowMetadataWithContent(): boolean;
    getComponent(fsPath: string, isResolvingSource?: boolean): undefined | SourceComponent;
}

Infers the source format structure of a metadata component when given a file path.

Type declaration

  • allowMetadataWithContent:function
    • allowMetadataWithContent(): boolean

    • Whether the adapter allows content-only metadata definitions.

      Returns boolean

  • getComponent:function
    • getComponent(fsPath, isResolvingSource?): undefined | SourceComponent

    • Create a metadata component object from a file path.

      Parameters

      • fsPath: string

        Path to resolve

      • OptionalisResolvingSource: boolean

        Whether the path to resolve is a single file

      Returns undefined | SourceComponent

Settings

Member Visibility