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

<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@apextoaster/js-yaml-schema](./js-yaml-schema.md) &gt; [createInclude](./js-yaml-schema.createinclude.md)

## createInclude() function

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

Includes must be resolved synchronously, which greatly limits where this can be used.

<b>Signature:</b>

```typescript
export declare function createInclude(options: Readonly<IncludeOptions>): IncludeResult;
```

## Parameters

|  Parameter | Type | Description |
|  --- | --- | --- |
|  options | Readonly&lt;[IncludeOptions](./js-yaml-schema.includeoptions.md)<!-- -->&gt; |  |

<b>Returns:</b>

IncludeResult