ssube
/
js-yaml-schema
1
0
Fork 0
Code
js-yaml-schema/docs/api/js-yaml-schema.createschema.md

24 lines
539 B
Markdown
Raw Normal View History

feat: switch to instantiated API, add `createSchema` entrypoint BREAKING CHANGE: this allows multiple schemas to coexist, but requires each schema to be created with a call to `createSchema`, taking a set of options that includes the former `includeOptions` singleton.
2020-08-09 01:01:34 +00:00
<!-- 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; [createSchema](./js-yaml-schema.createschema.md)
## createSchema() function
<b>Signature:</b>
```typescript
feat(schema): remove include type from default schema BREAKING CHANGE: the include type requires a significant subset of the synchronous fs API to be provided when creating a schema, even if the include type is never used. Since the resolution must be synchronous, the include type is limited to local fs and memory access, and not very useful with network loading. It has been removed from the default schema, but can be included by calling `createIncludeSchema` instead.
2021-07-10 20:12:59 +00:00
export declare function createSchema(options: SchemaOptions): Schema;
feat: switch to instantiated API, add `createSchema` entrypoint BREAKING CHANGE: this allows multiple schemas to coexist, but requires each schema to be created with a call to `createSchema`, taking a set of options that includes the former `includeOptions` singleton.
2020-08-09 01:01:34 +00:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
feat(schema): remove include type from default schema BREAKING CHANGE: the include type requires a significant subset of the synchronous fs API to be provided when creating a schema, even if the include type is never used. Since the resolution must be synchronous, the include type is limited to local fs and memory access, and not very useful with network loading. It has been removed from the default schema, but can be included by calling `createIncludeSchema` instead.
2021-07-10 20:12:59 +00:00
| options | [SchemaOptions](./js-yaml-schema.schemaoptions.md) | |
feat: switch to instantiated API, add `createSchema` entrypoint BREAKING CHANGE: this allows multiple schemas to coexist, but requires each schema to be created with a call to `createSchema`, taking a set of options that includes the former `includeOptions` singleton.
2020-08-09 01:01:34 +00:00
<b>Returns:</b>
feat: add optional base schema to schema options
2021-04-17 23:56:33 +00:00
Schema
feat: switch to instantiated API, add `createSchema` entrypoint BREAKING CHANGE: this allows multiple schemas to coexist, but requires each schema to be created with a call to `createSchema`, taking a set of options that includes the former `includeOptions` singleton.
2020-08-09 01:01:34 +00:00