lint: annotate exported types with release status
This commit is contained in:
parent
6ef98fbae4
commit
70a5fdab3c
|
@ -4,6 +4,8 @@
|
||||||
|
|
||||||
## CONFIG\_SCHEMA variable
|
## CONFIG\_SCHEMA variable
|
||||||
|
|
||||||
|
Safe schema with additional library types added.
|
||||||
|
|
||||||
<b>Signature:</b>
|
<b>Signature:</b>
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
|
|
|
@ -1,11 +0,0 @@
|
||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
||||||
|
|
||||||
[Home](./index.md) > [@apextoaster/js-yaml-schema](./js-yaml-schema.md) > [envType](./js-yaml-schema.envtype.md)
|
|
||||||
|
|
||||||
## envType variable
|
|
||||||
|
|
||||||
<b>Signature:</b>
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
envType: YamlType
|
|
||||||
```
|
|
|
@ -1,11 +0,0 @@
|
||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
||||||
|
|
||||||
[Home](./index.md) > [@apextoaster/js-yaml-schema](./js-yaml-schema.md) > [includeType](./js-yaml-schema.includetype.md)
|
|
||||||
|
|
||||||
## includeType variable
|
|
||||||
|
|
||||||
<b>Signature:</b>
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
includeType: YamlType
|
|
||||||
```
|
|
|
@ -8,10 +8,6 @@
|
||||||
|
|
||||||
| Variable | Description |
|
| Variable | Description |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| [CONFIG\_SCHEMA](./js-yaml-schema.config_schema.md) | |
|
| [CONFIG\_SCHEMA](./js-yaml-schema.config_schema.md) | Safe schema with additional library types added. |
|
||||||
| [envType](./js-yaml-schema.envtype.md) | |
|
|
||||||
| [includeSchema](./js-yaml-schema.includeschema.md) | The schema to be used for included files. This is necessary to work around circular dependency errors. |
|
| [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) | |
|
|
||||||
|
|
||||||
|
|
|
@ -1,11 +0,0 @@
|
||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
||||||
|
|
||||||
[Home](./index.md) > [@apextoaster/js-yaml-schema](./js-yaml-schema.md) > [regexpType](./js-yaml-schema.regexptype.md)
|
|
||||||
|
|
||||||
## regexpType variable
|
|
||||||
|
|
||||||
<b>Signature:</b>
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
regexpType: YamlType
|
|
||||||
```
|
|
|
@ -1,11 +0,0 @@
|
||||||
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
||||||
|
|
||||||
[Home](./index.md) > [@apextoaster/js-yaml-schema](./js-yaml-schema.md) > [streamType](./js-yaml-schema.streamtype.md)
|
|
||||||
|
|
||||||
## streamType variable
|
|
||||||
|
|
||||||
<b>Signature:</b>
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
streamType: YamlType
|
|
||||||
```
|
|
|
@ -5,6 +5,11 @@ import { includeSchema, includeType } from './type/Include';
|
||||||
import { regexpType } from './type/Regexp';
|
import { regexpType } from './type/Regexp';
|
||||||
import { streamType } from './type/Stream';
|
import { streamType } from './type/Stream';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Safe schema with additional library types added.
|
||||||
|
*
|
||||||
|
* @public
|
||||||
|
*/
|
||||||
export const CONFIG_SCHEMA = Schema.create([DEFAULT_SAFE_SCHEMA], [
|
export const CONFIG_SCHEMA = Schema.create([DEFAULT_SAFE_SCHEMA], [
|
||||||
envType,
|
envType,
|
||||||
includeType,
|
includeType,
|
||||||
|
|
|
@ -1,6 +1,9 @@
|
||||||
import { NotFoundError } from '@apextoaster/js-utils';
|
import { NotFoundError } from '@apextoaster/js-utils';
|
||||||
import { Type as YamlType } from 'js-yaml';
|
import { Type as YamlType } from 'js-yaml';
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
*/
|
||||||
export const envType = new YamlType('!env', {
|
export const envType = new YamlType('!env', {
|
||||||
kind: 'scalar',
|
kind: 'scalar',
|
||||||
resolve(name: string) {
|
resolve(name: string) {
|
||||||
|
|
|
@ -17,6 +17,8 @@ export interface IncludeSchema {
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* The schema to be used for included files. This is necessary to work around circular dependency errors.
|
* The schema to be used for included files. This is necessary to work around circular dependency errors.
|
||||||
|
*
|
||||||
|
* @public
|
||||||
*/
|
*/
|
||||||
export const includeSchema: IncludeSchema = {
|
export const includeSchema: IncludeSchema = {
|
||||||
exists: (path: string) => false,
|
exists: (path: string) => false,
|
||||||
|
@ -29,6 +31,9 @@ export const includeSchema: IncludeSchema = {
|
||||||
schema: SAFE_SCHEMA,
|
schema: SAFE_SCHEMA,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
*/
|
||||||
export const includeType = new YamlType('!include', {
|
export const includeType = new YamlType('!include', {
|
||||||
kind: 'scalar',
|
kind: 'scalar',
|
||||||
resolve(path: string) {
|
resolve(path: string) {
|
||||||
|
|
|
@ -3,6 +3,9 @@ import { Type as YamlType } from 'js-yaml';
|
||||||
|
|
||||||
export const REGEXP_REGEXP = /^\/(.+)\/([gimsuy]*)$/;
|
export const REGEXP_REGEXP = /^\/(.+)\/([gimsuy]*)$/;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
*/
|
||||||
export const regexpType = new YamlType('!regexp', {
|
export const regexpType = new YamlType('!regexp', {
|
||||||
kind: 'scalar',
|
kind: 'scalar',
|
||||||
resolve(value: string) {
|
resolve(value: string) {
|
||||||
|
|
|
@ -6,6 +6,9 @@ const ALLOWED_STREAMS = new Set([
|
||||||
'stderr',
|
'stderr',
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
*/
|
||||||
export const streamType = new YamlType('!stream', {
|
export const streamType = new YamlType('!stream', {
|
||||||
kind: 'scalar',
|
kind: 'scalar',
|
||||||
resolve(name: string) {
|
resolve(name: string) {
|
||||||
|
|
Loading…
Reference in New Issue