From afe7e8746c31a5963be9086e29610b3dfcfd5a28 Mon Sep 17 00:00:00 2001 From: Sean Sube Date: Sun, 30 Jan 2022 11:22:29 -0600 Subject: [PATCH] fix(deps): add istanbul schema for c8 --- .../api/js-yaml-schema.createincludeschema.md | 29 +++++++++++++++++++ ...s-yaml-schema.includeschemaoptions.base.md | 11 +++++++ ...aml-schema.includeschemaoptions.include.md | 11 +++++++ .../js-yaml-schema.includeschemaoptions.md | 23 +++++++++++++++ docs/api/js-yaml-schema.md | 2 ++ package.json | 1 + yarn.lock | 5 ++++ 7 files changed, 82 insertions(+) create mode 100644 docs/api/js-yaml-schema.createincludeschema.md create mode 100644 docs/api/js-yaml-schema.includeschemaoptions.base.md create mode 100644 docs/api/js-yaml-schema.includeschemaoptions.include.md create mode 100644 docs/api/js-yaml-schema.includeschemaoptions.md diff --git a/docs/api/js-yaml-schema.createincludeschema.md b/docs/api/js-yaml-schema.createincludeschema.md new file mode 100644 index 0000000..ee8b47d --- /dev/null +++ b/docs/api/js-yaml-schema.createincludeschema.md @@ -0,0 +1,29 @@ + + +[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. + +Signature: + +```typescript +export declare function createIncludeSchema(options: Readonly): Schema; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| options | Readonly<[IncludeSchemaOptions](./js-yaml-schema.includeschemaoptions.md)> | | + +Returns: + +Schema + diff --git a/docs/api/js-yaml-schema.includeschemaoptions.base.md b/docs/api/js-yaml-schema.includeschemaoptions.base.md new file mode 100644 index 0000000..ad09b61 --- /dev/null +++ b/docs/api/js-yaml-schema.includeschemaoptions.base.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@apextoaster/js-yaml-schema](./js-yaml-schema.md) > [IncludeSchemaOptions](./js-yaml-schema.includeschemaoptions.md) > [base](./js-yaml-schema.includeschemaoptions.base.md) + +## IncludeSchemaOptions.base property + +Signature: + +```typescript +base?: Schema; +``` diff --git a/docs/api/js-yaml-schema.includeschemaoptions.include.md b/docs/api/js-yaml-schema.includeschemaoptions.include.md new file mode 100644 index 0000000..93f6868 --- /dev/null +++ b/docs/api/js-yaml-schema.includeschemaoptions.include.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@apextoaster/js-yaml-schema](./js-yaml-schema.md) > [IncludeSchemaOptions](./js-yaml-schema.includeschemaoptions.md) > [include](./js-yaml-schema.includeschemaoptions.include.md) + +## IncludeSchemaOptions.include property + +Signature: + +```typescript +include: Readonly>; +``` diff --git a/docs/api/js-yaml-schema.includeschemaoptions.md b/docs/api/js-yaml-schema.includeschemaoptions.md new file mode 100644 index 0000000..05d8fe9 --- /dev/null +++ b/docs/api/js-yaml-schema.includeschemaoptions.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@apextoaster/js-yaml-schema](./js-yaml-schema.md) > [IncludeSchemaOptions](./js-yaml-schema.includeschemaoptions.md) + +## IncludeSchemaOptions interface + +> Warning: This API is now obsolete. +> +> + +Signature: + +```typescript +export interface IncludeSchemaOptions +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [base?](./js-yaml-schema.includeschemaoptions.base.md) | Schema | (Optional) | +| [include](./js-yaml-schema.includeschemaoptions.include.md) | Readonly<Omit<[IncludeOptions](./js-yaml-schema.includeoptions.md), 'schema'>> | | + diff --git a/docs/api/js-yaml-schema.md b/docs/api/js-yaml-schema.md index f5a02ee..3afda36 100644 --- a/docs/api/js-yaml-schema.md +++ b/docs/api/js-yaml-schema.md @@ -9,6 +9,7 @@ | Function | Description | | --- | --- | | [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. | +| [createIncludeSchema(options)](./js-yaml-schema.createincludeschema.md) | Extended schema with the include type, and auto-configuration of the include schema. | | [createSchema(options)](./js-yaml-schema.createschema.md) | | ## Interfaces @@ -16,6 +17,7 @@ | Interface | Description | | --- | --- | | [IncludeOptions](./js-yaml-schema.includeoptions.md) | Additional options for the include type. | +| [IncludeSchemaOptions](./js-yaml-schema.includeschemaoptions.md) | | | [SchemaOptions](./js-yaml-schema.schemaoptions.md) | | ## Variables diff --git a/package.json b/package.json index ba49547..4fce03e 100644 --- a/package.json +++ b/package.json @@ -17,6 +17,7 @@ "devDependencies": { "@apextoaster/js-utils": "0.4.0", "@istanbuljs/nyc-config-typescript": "1.0.2", + "@istanbuljs/schema": "^0.1.3", "@microsoft/api-documenter": "7.15.1", "@microsoft/api-extractor": "7.19.4", "@types/chai": "4.3.0", diff --git a/yarn.lock b/yarn.lock index 3f0bfef..9175a0a 100644 --- a/yarn.lock +++ b/yarn.lock @@ -69,6 +69,11 @@ resolved "https://artifacts.apextoaster.com/repository/group-npm/@istanbuljs/schema/-/schema-0.1.2.tgz#26520bf09abe4a5644cd5414e37125a8954241dd" integrity sha512-tsAQNx32a8CoFhjhijUIhI4kccIAgmGhy8LZMZgGfmXcpMbPRUqn5LWmgRttILi6yeGmBJd2xsPkFMs0PzgPCw== +"@istanbuljs/schema@^0.1.3": + version "0.1.3" + resolved "https://artifacts.apextoaster.com/repository/group-npm/@istanbuljs/schema/-/schema-0.1.3.tgz#e45e384e4b8ec16bce2fd903af78450f6bf7ec98" + integrity sha512-ZXRY4jNvVgSVQ8DL3LTcakaAtXwTVUxE81hslsyD2AtoXW/wVob10HkOJ1X/pAlcI7D+2YoZKg5do8G/w6RYgA== + "@microsoft/api-documenter@7.15.1": version "7.15.1" resolved "https://artifacts.apextoaster.com/repository/group-npm/@microsoft/api-documenter/-/api-documenter-7.15.1.tgz#2ac4ea475b0b54c0aa664e04b6e85828982ae226"