Class SparqlFormatter

Formatter for SPARQL queries and updates.

Uses the W3C-compliant SparqlLexer from mentor-rdf-parsers for tokenization.

This formatter can:

Format SPARQL 1.1/1.2 queries and updates
Normalize keyword casing
Apply consistent indentation
Align triple patterns
Preserve comments
Preserve source newlines and blank lines

See

https://www.w3.org/TR/sparql12-query/

Hierarchy (View Summary)

TokenFormatterBase<SparqlFormatterContext, SparqlFormatterOptions>
- SparqlFormatter

Implements

ISparqlFormatter

Index

Constructors

Methods

formatFromText formatFromTokens

Constructors

constructor

new SparqlFormatter(): SparqlFormatter
Returns SparqlFormatter
Inherited from TokenFormatterBase.constructor

Methods

formatFromText

formatFromText(
query: string,
options?: SparqlFormatterOptions,
): SerializationResult
Formats a SPARQL query string.
Parameters
- query: string
- Optionaloptions: SparqlFormatterOptions
Returns SerializationResult
Implementation of ISparqlFormatter.formatFromText
- Defined in formatters/sparql-formatter.ts:89

formatFromTokens

formatFromTokens(
tokens: IToken[],
options?: SparqlFormatterOptions & TokenSerializerOptions,
): SerializationResult
Formats SPARQL from parsed tokens.
Parameters
- tokens: IToken[]
- Optionaloptions: SparqlFormatterOptions & TokenSerializerOptions
Returns SerializationResult
Implementation of ISparqlFormatter.formatFromTokens
- Defined in formatters/sparql-formatter.ts:100