DefinitelyTyped/types/json-to-ast/index.d.ts
ExE Boss 534f9b6fb6 feat: Add json-to-ast (#35818)
* feat: Add `json-to-ast`

* test(json‑to‑ast): Fix UMD global test

* fix(json‑to‑ast): Remove `strict` compiler option

* test(json‑to‑ast): Move type assertions at the end of the line

* refactor(json‑to‑ast): Apply Prettier formatting
2019-05-30 14:31:15 -07:00

75 lines
1.4 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// Type definitions for json-to-ast 2.1
// Project: https://github.com/vtrushin/json-to-ast
// Definitions by: ExE Boss <https://github.com/ExE-Boss>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare namespace parse {
interface Options {
/**
* Appends location information.
*
* @default true
*/
loc?: boolean;
/**
* Appends source information to nodes location.
*
* @default null
*/
source?: string;
}
type ValueNode = ObjectNode | ArrayNode | LiteralNode;
interface Position {
line: number;
column: number;
offset: number;
}
interface Location {
start: Position;
end: Position;
source: string | null;
}
interface ASTNode {
type: string;
loc?: Location;
}
interface ObjectNode extends ASTNode {
type: "Object";
children: PropertyNode[];
}
interface PropertyNode extends ASTNode {
type: "Property";
key: IdentifierNode;
value: ValueNode;
}
interface IdentifierNode extends ASTNode {
type: "Identifier";
value: string;
raw: string;
}
interface ArrayNode extends ASTNode {
type: "Array";
children: ValueNode[];
}
interface LiteralNode extends ASTNode {
type: "Literal";
value: string | number | boolean | null;
raw: string;
}
}
declare function parse(json: string, settings?: parse.Options): parse.ValueNode;
export = parse;
export as namespace jsonToAst;