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

API Report File for "@apextoaster/js-yaml-schema"

Do not edit this file. It is a report generated by API Extractor.

import { Maybe } from '@apextoaster/js-utils';
import { Schema } from 'js-yaml';
import { Type } from 'js-yaml';

// Warning: (ae-forgotten-export) The symbol "IncludeResult" needs to be exported by the entry point index.d.ts
//
// @public
export function createInclude(options: Readonly<IncludeOptions>): IncludeResult;

// @public @deprecated
export function createIncludeSchema(options: Readonly<IncludeSchemaOptions>): Schema;

// @public (undocumented)
export function createSchema(options: SchemaOptions): Schema;

// @public (undocumented)
export const envType: Type;

// @public
export interface IncludeOptions {
    // (undocumented)
    exists: (path: string) => boolean;
    // (undocumented)
    join: (...path: Array<string>) => string;
    // Warning: (ae-forgotten-export) The symbol "IncludeReader" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    read: IncludeReader;
    // (undocumented)
    resolve: (path: string) => string;
    // (undocumented)
    schema: Maybe<Schema>;
}

// @public @deprecated (undocumented)
export interface IncludeSchemaOptions {
    // (undocumented)
    base?: Schema;
    // (undocumented)
    include: Readonly<Omit<IncludeOptions, 'schema'>>;
}

// @public (undocumented)
export const regexpType: Type;

// @public (undocumented)
export interface SchemaOptions {
    // (undocumented)
    base?: Schema;
}

// @public (undocumented)
export const streamType: Type;

// (No @packageDocumentation comment for this package)