mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-05-04 21:19:53 +08:00
96 lines
3.6 KiB
TypeScript
96 lines
3.6 KiB
TypeScript
// Type definitions for js-yaml 3.9.0
|
|
// Project: https://github.com/nodeca/js-yaml
|
|
// Definitions by: Bart van der Schoor <https://github.com/Bartvds>, Sebastian Clausen <https://github.com/sclausen>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
declare namespace jsyaml {
|
|
export function safeLoad(str: string, opts?: LoadOptions): any;
|
|
export function load(str: string, opts?: LoadOptions): any;
|
|
|
|
export interface Type extends TypeConstructorOptions { }
|
|
export class Type {
|
|
constructor(tag: string, opts?: TypeConstructorOptions);
|
|
tag: string;
|
|
}
|
|
export class Schema {
|
|
constructor(definition: SchemaDefinition);
|
|
public static create(args: any[]): Schema;
|
|
}
|
|
|
|
export function safeLoadAll(str: string, iterator: (doc: any) => void, opts?: LoadOptions): any;
|
|
export function loadAll(str: string, iterator: (doc: any) => void, opts?: LoadOptions): any;
|
|
|
|
export function safeDump(obj: any, opts?: DumpOptions): string;
|
|
export function dump(obj: any, opts?: DumpOptions): string;
|
|
|
|
export interface LoadOptions {
|
|
// string to be used as a file path in error/warning messages.
|
|
filename?: string;
|
|
// makes the loader to throw errors instead of warnings.
|
|
strict?: boolean;
|
|
// specifies a schema to use.
|
|
schema?: any;
|
|
}
|
|
|
|
export interface DumpOptions {
|
|
// indentation width to use (in spaces).
|
|
indent?: number;
|
|
// do not throw on invalid types (like function in the safe schema) and skip pairs and single values with such types.
|
|
skipInvalid?: boolean;
|
|
// specifies level of nesting, when to switch from block to flow style for collections. -1 means block style everwhere
|
|
flowLevel?: number;
|
|
// Each tag may have own set of styles. - "tag" => "style" map.
|
|
styles?: Object;
|
|
// specifies a schema to use.
|
|
schema?: any;
|
|
// if true, sort keys when dumping YAML. If a function, use the function to sort the keys. (default: false)
|
|
sortKeys?: boolean | ((a: any, b: any) => number);
|
|
// set max line width. (default: 80)
|
|
lineWidth?: number;
|
|
// if true, don't convert duplicate objects into references (default: false)
|
|
noRefs?: boolean;
|
|
// if true don't try to be compatible with older yaml versions. Currently: don't quote "yes", "no" and so on, as required for YAML 1.1 (default: false)
|
|
noCompatMode?: boolean;
|
|
// if true flow sequences will be condensed, omitting the space between `key: value` or `a, b`. Eg. `'[a,b]'` or `{a:{b:c}}`. Can be useful when using yaml for pretty URL query params as spaces are %-encoded. (default: false)
|
|
condenseFlow?: boolean;
|
|
}
|
|
|
|
export interface TypeConstructorOptions {
|
|
kind?: string;
|
|
resolve?: Function;
|
|
construct?: Function;
|
|
instanceOf?: Object;
|
|
predicate?: string;
|
|
represent?: Function;
|
|
defaultStyle?: string;
|
|
styleAliases?: Object;
|
|
}
|
|
|
|
export interface SchemaDefinition {
|
|
implicit?: any[];
|
|
explicit?: any[];
|
|
include?: any[];
|
|
}
|
|
|
|
// only strings, arrays and plain objects: http://www.yaml.org/spec/1.2/spec.html#id2802346
|
|
export var FAILSAFE_SCHEMA: any;
|
|
// only strings, arrays and plain objects: http://www.yaml.org/spec/1.2/spec.html#id2802346
|
|
export var JSON_SCHEMA: any;
|
|
// same as JSON_SCHEMA: http://www.yaml.org/spec/1.2/spec.html#id2804923
|
|
export var CORE_SCHEMA: any;
|
|
// all supported YAML types, without unsafe ones (!!js/undefined, !!js/regexp and !!js/function): http://yaml.org/type/
|
|
export var DEFAULT_SAFE_SCHEMA: any;
|
|
// all supported YAML types.
|
|
export var DEFAULT_FULL_SCHEMA: any;
|
|
export var MINIMAL_SCHEMA: any;
|
|
export var SAFE_SCHEMA: any;
|
|
|
|
export class YAMLException extends Error {
|
|
constructor(reason?: any, mark?: any);
|
|
toString(compact?: boolean): string;
|
|
}
|
|
}
|
|
|
|
export = jsyaml;
|
|
export as namespace jsyaml;
|