28 lines
773 B
Markdown
28 lines
773 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 includer with closure over the provided options.
|
|
|
|
<b>Signature:</b>
|
|
|
|
```typescript
|
|
export declare function createInclude(options: Readonly<IncludeOptions>): {
|
|
includeType: YamlType;
|
|
setSchema: (schema: Schema) => void;
|
|
};
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --- | --- | --- |
|
|
| options | Readonly<[IncludeOptions](./js-yaml-schema.includeoptions.md)<!-- -->> | |
|
|
|
|
<b>Returns:</b>
|
|
|
|
{ includeType: YamlType; setSchema: (schema: Schema) => void; }
|
|
|