lint: annotate exported types with release status

docs/api/js-yaml-schema.config_schema.md

@@ -4,6 +4,8 @@
 
 ## CONFIG\_SCHEMA variable
 
+Safe schema with additional library types added.
+
 <b>Signature:</b>
 
 ```typescript

docs/api/js-yaml-schema.envtype.md

@@ -1,11 +0,0 @@
-<!-- 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; [envType](./js-yaml-schema.envtype.md)
-
-## envType variable
-
-<b>Signature:</b>
-
-```typescript
-envType: YamlType
-```

docs/api/js-yaml-schema.includetype.md

@@ -1,11 +0,0 @@
-<!-- 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; [includeType](./js-yaml-schema.includetype.md)
-
-## includeType variable
-
-<b>Signature:</b>
-
-```typescript
-includeType: YamlType
-```

docs/api/js-yaml-schema.md

@@ -8,10 +8,6 @@
 
 |  Variable | Description |
 |  --- | --- |
-|  [CONFIG\_SCHEMA](./js-yaml-schema.config_schema.md) |  |
-|  [envType](./js-yaml-schema.envtype.md) |  |
+|  [CONFIG\_SCHEMA](./js-yaml-schema.config_schema.md) | Safe schema with additional library types added. |
 |  [includeSchema](./js-yaml-schema.includeschema.md) | The schema to be used for included files. This is necessary to work around circular dependency errors. |
-|  [includeType](./js-yaml-schema.includetype.md) |  |
-|  [regexpType](./js-yaml-schema.regexptype.md) |  |
-|  [streamType](./js-yaml-schema.streamtype.md) |  |
 

docs/api/js-yaml-schema.regexptype.md

@@ -1,11 +0,0 @@
-<!-- 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; [regexpType](./js-yaml-schema.regexptype.md)
-
-## regexpType variable
-
-<b>Signature:</b>
-
-```typescript
-regexpType: YamlType
-```

docs/api/js-yaml-schema.streamtype.md

@@ -1,11 +0,0 @@
-<!-- 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; [streamType](./js-yaml-schema.streamtype.md)
-
-## streamType variable
-
-<b>Signature:</b>
-
-```typescript
-streamType: YamlType
-```

src/schema.ts

@@ -5,6 +5,11 @@ import { includeSchema, includeType } from './type/Include';
 import { regexpType } from './type/Regexp';
 import { streamType } from './type/Stream';
 
+/**
+ * Safe schema with additional library types added.
+ *
+ * @public
+ */
 export const CONFIG_SCHEMA = Schema.create([DEFAULT_SAFE_SCHEMA], [
   envType,
   includeType,

src/type/Env.ts

@@ -1,6 +1,9 @@
 import { NotFoundError } from '@apextoaster/js-utils';
 import { Type as YamlType } from 'js-yaml';
 
+/**
+ * @internal
+ */
 export const envType = new YamlType('!env', {
   kind: 'scalar',
   resolve(name: string) {

src/type/Include.ts

@@ -17,6 +17,8 @@ export interface IncludeSchema {
 
 /**
  * The schema to be used for included files. This is necessary to work around circular dependency errors.
+ *
+ * @public
  */
 export const includeSchema: IncludeSchema = {
   exists: (path: string) => false,
@@ -29,6 +31,9 @@ export const includeSchema: IncludeSchema = {
   schema: SAFE_SCHEMA,
 };
 
+/**
+ * @internal
+ */
 export const includeType = new YamlType('!include', {
   kind: 'scalar',
   resolve(path: string) {

src/type/Regexp.ts

@@ -3,6 +3,9 @@ import { Type as YamlType } from 'js-yaml';
 
 export const REGEXP_REGEXP = /^\/(.+)\/([gimsuy]*)$/;
 
+/**
+ * @internal
+ */
 export const regexpType = new YamlType('!regexp', {
   kind: 'scalar',
   resolve(value: string) {

src/type/Stream.ts

@@ -6,6 +6,9 @@ const ALLOWED_STREAMS = new Set([
   'stderr',
 ]);
 
+/**
+ * @internal
+ */
 export const streamType = new YamlType('!stream', {
   kind: 'scalar',
   resolve(name: string) {