30 lines
853 B
Markdown
30 lines
853 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) > [createIncludeSchema](./js-yaml-schema.createincludeschema.md)
|
||
|
|
|
||
|
|
## createIncludeSchema() function
|
||
|
|
|
||
|
|
> Warning: This API is now obsolete.
|
||
|
|
>
|
||
|
|
> use `createSchema` unless the include type is needed, since it requires a number of callbacks
|
||
|
|
>
|
||
|
|
|
||
|
|
Extended schema with the include type, and auto-configuration of the include schema.
|
||
|
|
|
||
|
|
<b>Signature:</b>
|
||
|
|
|
||
|
|
```typescript
|
||
|
|
export declare function createIncludeSchema(options: Readonly<IncludeSchemaOptions>): Schema;
|
||
|
|
```
|
||
|
|
|
||
|
|
## Parameters
|
||
|
|
|
||
|
|
| Parameter | Type | Description |
|
||
|
|
| --- | --- | --- |
|
||
|
|
| options | Readonly<[IncludeSchemaOptions](./js-yaml-schema.includeschemaoptions.md)<!-- -->> | |
|
||
|
|
|
||
|
|
<b>Returns:</b>
|
||
|
|
|
||
|
|
Schema
|
||
|
|
|