27 lines
799 B
Markdown
27 lines
799 B
Markdown
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
|
|
[Home](./index.md) > [@apextoaster/js-yaml-schema](./js-yaml-schema.md) > [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<[IncludeOptions](./js-yaml-schema.includeoptions.md)<!-- -->> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
IncludeResult
|
|
|