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

31 lines
1.3 KiB
Markdown
Raw Normal View History

feat(type): add env, include, regexp, and stream
2019-11-13 14:20: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)
## js-yaml-schema package
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
## Functions
| Function | 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
| [createInclude(options)](./js-yaml-schema.createinclude.md) | 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. |
fix(deps): add istanbul schema for c8
2022-01-30 17:22:29 +00:00
| [createIncludeSchema(options)](./js-yaml-schema.createincludeschema.md) | Extended schema with the include type, and auto-configuration of the include schema. |
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
| [createSchema(options)](./js-yaml-schema.createschema.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
## Interfaces
| Interface | 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
| [IncludeOptions](./js-yaml-schema.includeoptions.md) | Additional options for the include type. |
fix(deps): add istanbul schema for c8
2022-01-30 17:22:29 +00:00
| [IncludeSchemaOptions](./js-yaml-schema.includeschemaoptions.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
| [SchemaOptions](./js-yaml-schema.schemaoptions.md) | |
fix: refactor duplicate utils into js-utils, export symbols BREAKING CHANGE: extract typed errors and use the equivalent from js-utils
2020-03-29 13:13:57 +00:00
## Variables
| Variable | Description |
| --- | --- |
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
| [envType](./js-yaml-schema.envtype.md) | |
| [regexpType](./js-yaml-schema.regexptype.md) | |
| [streamType](./js-yaml-schema.streamtype.md) | |
fix: refactor duplicate utils into js-utils, export symbols BREAKING CHANGE: extract typed errors and use the equivalent from js-utils
2020-03-29 13:13:57 +00:00