2022-01-30 17:22:29 +00:00
|
|
|
<!-- 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.
|
|
|
|
>
|
2022-10-08 21:07:43 +00:00
|
|
|
> either use `createSchema` by itself, or `createInclude` and extend the schema yourself
|
2022-01-30 17:22:29 +00:00
|
|
|
>
|
|
|
|
|
|
|
|
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
|
|
|
|
|