js-yaml-schema/docs/api/js-yaml-schema.createinclude.md

Home > @apextoaster/js-yaml-schema > createInclude

createInclude() function

Instantiate an include type with a copy of the provided options, returning the include type and its schema setter.

Signature:

export declare function createInclude(options: Readonly<IncludeOptions>): {
    includeType: YamlType;
    setSchema: (schema: Schema) => void;
};

Parameters

Parameter	Type	Description
options	Readonly<IncludeOptions>

Returns:

{ includeType: YamlType; setSchema: (schema: Schema) => void; }