@matdata/sparql-formatter 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * SPARQL 1.2 formatter.
+ *
+ * ```js
+ * import { format } from "@matdata/sparql-formatter";
+ * format("select * where {?s ?p ?o}");
+ * ```
+ */
+import type { Ast } from "./ast.js";
+import { parse } from "./parser.js";
+import { type FormatOptions } from "./printer.js";
+import { tokenize } from "./lexer.js";
+export { parse } from "./parser.js";
+export { tokenize } from "./lexer.js";
+export { SparqlSyntaxError } from "./errors.js";
+export type { FormatOptions, Case } from "./printer.js";
+export type { Token, Comment, TokenType } from "./lexer.js";
+export type * from "./ast.js";
+/** Format a parsed query. */
+export declare function formatAst(ast: Ast, options?: FormatOptions): string;
+/**
+ * Format a SPARQL 1.2 query or update.
+ *
+ * @throws {SparqlSyntaxError} when the input is not valid SPARQL.
+ */
+export declare function format(query: string, options?: FormatOptions): string;
+/** Check whether a query is valid SPARQL 1.2 syntax. */
+export declare function isValid(query: string): boolean;
+/**
+ * Drop-in replacement for the `spfmt` object of the `sparql-formatter`
+ * package (`spfmt.format(query, formattingMode, indentDepth)`).
+ */
+export declare const spfmt: {
+    parse: typeof parse;
+    tokenize: typeof tokenize;
+    format(query: string, formattingMode?: "default" | "compact", indentDepth?: number): string;
+};
+export default format;